Special store used to work with APS resources within the APS infrastructure.
Table of contents
ARGUMENT |
TYPE |
DESCRIPTION |
---|---|---|
|
dojo.store.JsonRest
|
This provides any configuration information that will be mixed into the store apsType: the type of apsResource |
PROPERTY |
TYPE |
DEFAULT |
DESCRIPTION |
---|---|---|---|
string |
“” |
Defines the type of the APS resource that this store should work with. |
|
string |
null |
RQL statement that will be added to every request for a list of resources. |
|
string |
undefined |
The name of the property in the data property that contains the list of child objects. |
|
string |
aps.id |
Similar to dojo/store/JsonStore, indicates the property to use as the identity property. |
|
array |
null |
Data preload for Store. |
|
string |
“” |
The target base URL to use for all requests to the server. |
Defines the type of the APS resource that this store should work with. For example, http://apsstandard.com/mailbox/1.0, http://mycompany.com/user/1.0, and so on. Default value: “”.
RQL statement that will be added to every request for a list of resources. Default value: null.
The name of the property in the data property that contains the list of child objects. Default value: undefined.
Similar to dojo/store/JsonStore, indicates the property to use as the identity property. However, APS resources already have their own id property called “aps.id” - so you should not define this property yourself if you are working with APS resources. Default value: “aps.id”.
Data preload for Store. Default value: null.
The target base URL to use for all requests to the server. This string will be prepended to the id to generate the URL (relative or absolute) for requests sent to the server. Default value: “”.
METHOD |
RETURN |
DESCRIPTION |
---|---|---|
object
|
Retrieves an object by its identity |
|
any
|
Returns an object’s identity |
|
row
object
|
Method for preparing data before completing request |
|
dojo/_base/deferred
|
Stores an object |
|
store.queryresults
|
Queries the store for objects |
|
dojo/_base/deferred
|
Deletes an object by its identity |
Retrieves an object by its identity. This will trigger a GET request to the server using the url this.target + id.
Return: object
Returns an object’s identity.
Return: any
ARGUMENT |
TYPE |
DESCRIPTION |
---|---|---|
|
Object
|
The object to store. |
Method for preparing data before completing request
Return: row object
ARGUMENT |
TYPE |
DESCRIPTION |
---|---|---|
|
Object
|
Received from server row which must be processed |
Stores an object. This will trigger a PUT request to the server if the object has an id, otherwise it will trigger a POST request.
Return: dojo/_base/deferred
Queries the store for objects. This will trigger a GET request to the server with the query added as a query string.
Return: store.queryresults
ARGUMENT |
TYPE |
DESCRIPTION |
---|---|---|
|
Object
|
The query to use for retrieving objects from the store. |
|
__QueryOptions
|
The optional arguments to apply to the resultset. |
Deletes an object by its identity. This will trigger a DELETE request to the server.
Return: dojo/_base/deferred