dojo-pkg 1.111.0

data/data/dojo-release-1.1.1-src/dojo/data/api/Identity.js

@@ -0,0 +1,103 @@
+dojo.provide("dojo.data.api.Identity");
+dojo.require("dojo.data.api.Read");
+
+dojo.declare("dojo.data.api.Identity", dojo.data.api.Read, {
+	//	summary:
+	//		This is an abstract API that data provider implementations conform to.
+	//		This file defines methods signatures and intentionally leaves all the
+	//		methods unimplemented.
+
+	getFeatures: function(){
+		//	summary: 
+		//		See dojo.data.api.Read.getFeatures()
+		return {
+			 'dojo.data.api.Read': true,
+			 'dojo.data.api.Identity': true
+		};
+	},
+
+	getIdentity: function(/* item */ item){
+		//	summary:
+		//		Returns a unique identifier for an item.  The return value will be
+		//		either a string or something that has a toString() method (such as,
+		//		for example, a dojox.uuid.Uuid object).
+		//	item:
+		//		The item from the store from which to obtain its identifier.
+		//	exceptions:
+		//		Conforming implementations may throw an exception or return null if
+		//		item is not an item.
+		//	example:
+		//	|	var itemId = store.getIdentity(kermit);
+		//	|	assert(kermit === store.findByIdentity(store.getIdentity(kermit)));
+		throw new Error('Unimplemented API: dojo.data.api.Identity.getIdentity');
+		var itemIdentityString = null;
+		return itemIdentityString; // string
+	},
+
+	getIdentityAttributes: function(/* item */ item){
+		//	summary:
+		//		Returns an array of attribute names that are used to generate the identity. 
+		//		For most stores, this is a single attribute, but for some complex stores
+		//		such as RDB backed stores that use compound (multi-attribute) identifiers
+		//		it can be more than one.  If the identity is not composed of attributes
+		//		on the item, it will return null.  This function is intended to identify
+		//		the attributes that comprise the identity so that so that during a render
+		//		of all attributes, the UI can hide the the identity information if it 
+		//		chooses.
+		//	item:
+		//		The item from the store from which to obtain the array of public attributes that 
+		//		compose the identifier, if any.
+		//	example:
+		//	|	var itemId = store.getIdentity(kermit);
+		//	|	var identifiers = store.getIdentityAttributes(itemId);
+		//	|	assert(typeof identifiers === "array" || identifiers === null);
+		throw new Error('Unimplemented API: dojo.data.api.Identity.getIdentityAttributes');
+		return null; // string
+	},
+
+
+	fetchItemByIdentity: function(/* object */ keywordArgs){
+		//	summary:
+		//		Given the identity of an item, this method returns the item that has 
+		//		that identity through the onItem callback.  Conforming implementations 
+		//		should return null if there is no item with the given identity.  
+		//		Implementations of fetchItemByIdentity() may sometimes return an item 
+		//		from a local cache and may sometimes fetch an item from a remote server, 
+		//
+		// 	keywordArgs:
+		//		An anonymous object that defines the item to locate and callbacks to invoke when the 
+		//		item has been located and load has completed.  The format of the object is as follows:
+		//		{
+		//			identity: string|object,
+		//			onItem: Function,
+		//			onError: Function,
+		//			scope: object
+		//		}
+		//	The *identity* parameter.
+		//		The identity parameter is the identity of the item you wish to locate and load
+		//		This attribute is required.  It should be a string or an object that toString() 
+		//		can be called on.
+		//		
+		//	The *onItem* parameter.
+		//		Function(item)
+		//		The onItem parameter is the callback to invoke when the item has been loaded.  It takes only one
+		//		parameter, the item located, or null if none found.
+		//
+		//	The *onError* parameter.
+		//		Function(error)
+		//		The onError parameter is the callback to invoke when the item load encountered an error.  It takes only one
+		//		parameter, the error object
+		//
+		//	The *scope* parameter.
+		//		If a scope object is provided, all of the callback functions (onItem, 
+		//		onError, etc) will be invoked in the context of the scope object.
+		//		In the body of the callback function, the value of the "this"
+		//		keyword will be the scope object.   If no scope object is provided,
+		//		the callback functions will be called in the context of dojo.global.
+		//		For example, onItem.call(scope, item, request) vs. 
+		//		onItem.call(dojo.global, item, request)
+		if (!this.isItemLoaded(keywordArgs.item)) {
+			throw new Error('Unimplemented API: dojo.data.api.Identity.fetchItemByIdentity');
+		}
+	}
+});

data/data/dojo-release-1.1.1-src/dojo/data/api/Notification.js

@@ -0,0 +1,115 @@
+dojo.provide("dojo.data.api.Notification");
+dojo.require("dojo.data.api.Read");
+
+dojo.declare("dojo.data.api.Notification", dojo.data.api.Read, {
+	//	summary:
+	//		This is an abstract API that data provider implementations conform to.
+	//		This file defines functions signatures and intentionally leaves all the
+	//		functions unimplemented.
+	//
+	//	description:
+	//		This API defines a set of APIs that all datastores that conform to the
+	//		Notifications API must implement.  In general, most stores will implement 
+	//		these APIs as no-op functions for users who wish to monitor them to be able
+	//		to connect to then via dojo.connect().  For non-users of dojo.connect, 
+	//		they should be able to just replace the function on the store to obtain
+	//		 notifications.  Both read-only and read-write stores may implement
+	//		this feature.  In the case of a read-only store, this feature makes sense if 
+	//		the store itself does internal polling to a back-end server and periodically updates
+	//		its cache of items (deletes, adds, and updates).
+	//
+	//	example:
+	//
+	//	|	function onSet(item, attribute, oldValue, newValue) {
+	//	|		//Do something with the information...
+	//	|	};
+	//	|	var store = new some.newStore();
+	//	|	dojo.connect(store, "onSet", onSet);
+
+	getFeatures: function(){
+		//	summary: 
+		//		See dojo.data.api.Read.getFeatures()
+		return {
+			'dojo.data.api.Read': true,
+			'dojo.data.api.Notification': true
+		};
+	},
+
+	onSet: function(/* item */ item, 
+					/* attribute-name-string */ attribute, 
+					/* object | array */ oldValue,
+					/* object | array */ newValue){
+		//	summary:
+		//		This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.  
+		//	description:
+		//		This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.  
+		//		Its purpose is to provide a hook point for those who wish to monitor actions on items in the store 
+		//		in a simple manner.  The general expected usage is to dojo.connect() to the store's 
+		//		implementation and be called after the store function is called.
+		//
+		//	item:
+		//		The item being modified.
+		//	attribute:
+		//		The attribute being changed represented as a string name.
+		//	oldValue:
+		//		The old value of the attribute.  In the case of single value calls, such as setValue, unsetAttribute, etc,
+		//		this value will be generally be an atomic value of some sort (string, int, etc, object).  In the case of 
+		//		multi-valued attributes, it will be an array.
+		//	newValue:
+		//		The new value of the attribute.  In the case of single value calls, such as setValue, this value will be 
+		//		generally be an atomic value of some sort (string, int, etc, object).  In the case of multi-valued attributes, 
+		//		it will be an array.  In the case of unsetAttribute, the new value will be 'undefined'.
+		//
+		//	returns:
+		//		Nothing.
+		throw new Error('Unimplemented API: dojo.data.api.Notification.onSet');
+	},
+
+	onNew: function(/* item */ newItem, /*object?*/ parentInfo){
+		//	summary:
+		//		This function is called any time a new item is created in the store.
+		//		It is called immediately after the store newItem processing has completed.
+		//	description:
+		//		This function is called any time a new item is created in the store.
+		//		It is called immediately after the store newItem processing has completed.
+		//
+		//	newItem:
+		//		The item created.
+		//	parentInfo:
+		//		An optional javascript object that is passed when the item created was placed in the store
+		//		hierarchy as a value f another item's attribute, instead of a root level item.  Note that if this
+		//		function is invoked with a value for parentInfo, then onSet is not invoked stating the attribute of
+		//		the parent item was modified.  This is to avoid getting two notification  events occurring when a new item
+		//		with a parent is created.  The structure passed in is as follows:
+		//		{
+		//			item: someItem,							//The parent item
+		//			attribute:	"attribute-name-string",	//The attribute the new item was assigned to.
+		//			oldValue: something	//Whatever was the previous value for the attribute.  
+		//						//If it is a single-value attribute only, then this value will be a single value.
+		//						//If it was a multi-valued attribute, then this will be an array of all the values minues the new one.
+		//			newValue: something	//The new value of the attribute.  In the case of single value calls, such as setValue, this value will be
+		//						//generally be an atomic value of some sort (string, int, etc, object).  In the case of multi-valued attributes,
+		//						//it will be an array.  
+		//		}
+		//
+		//	returns:
+		//		Nothing.
+		throw new Error('Unimplemented API: dojo.data.api.Notification.onNew');
+	},
+
+	onDelete: function(/* item */ deletedItem){
+		//	summary:
+		//		This function is called any time an item is deleted from the store.
+		//		It is called immediately after the store deleteItem processing has completed.
+		//	description:
+		//		This function is called any time an item is deleted from the store.
+		//		It is called immediately after the store deleteItem processing has completed.
+		//
+		//	deletedItem:
+		//		The item deleted.
+		//
+		//	returns:
+		//		Nothing.
+		throw new Error('Unimplemented API: dojo.data.api.Notification.onDelete');
+	}
+});