Methods
add(object, addOptions)
Creates an object, throws an error if the object already exists.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
object |
Object | The object to store |
||||||
addOptions |
Object | Additional directives for creating objects Properties
|
- Source:
getChildren()
Not implemented in this store.
- Source:
getEntity(object) → {String|Object}
Returns an object's entity using this.entityProperty
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object | The object to get the entity from |
- Source:
Returns:
- Type
- String | Object
getIdentity(object) → {String|Number}
Returns an object's identity using this.idProperty
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object | The object to get the identity from |
- Source:
Returns:
- Type
- String | Number
getLabel(object) → {String}
Returns an object's label using this.labelProperty
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object | The object to get the label from |
- Source:
Returns:
- Type
- String
getMetadata(object) → {Object|String|Number|String|String|Object|String}
Returns any metadata about the object. This may include attribution, cache directives, history, or version information.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object | The object to return metadata for. |
- Source:
Returns:
-
Object containing the metadata.
- Type
- Object
-
return.id
- Type
- String | Number
-
return.label
- Type
- String
-
return.entity
- Type
- String | Object
-
return.version
- Type
- String
getVersion(object) → {String}
Returns an object's version using this.versionProperty
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object | The object to get the version from |
- Source:
Returns:
- Type
- String
put(object, putOptions) → {String|Number}
Stores an object.
Parameters:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
object |
Object | The object to store. |
|||||||||||||||
putOptions |
Object | Additional directives for storing objects. Properties
|
- Source:
Returns:
- Type
- String | Number
query(query, queryOptions) → {dojo.store.api.Store.QueryResults}
Queries the store for objects. This does not alter the store, but returns a set of data from the store.
Parameters:
| Name | Type | Description |
|---|---|---|
query |
String | Object | function | The query to use for retrieving objects from the store. |
queryOptions |
Object |
- Source:
Returns:
- Type
- dojo.store.api.Store.QueryResults
remove(entry, removeOptions)
Deletes an entry
Parameters:
| Name | Type | Description |
|---|---|---|
entry |
Object | The entry to be removed. |
removeOptions |
Object | additional directives for removing options. |
- Source:
transaction()
Not implemented in this store.
- Source: