IBM® OpenSearchStore reference

The OpenSearch store implements only the Read dojo.data API. See the following reference documentation for the API. This documentation comes from the dojo.data.api.Read file and is generic to all stores. The only limitation to the OpenSearch store is attributes. There is only one attribute defined for any item in the OpenSearch store, labeled content, which is the content of that search result. These results include the content element in an Atom feed, the description element in an RSS feed, and the HTML content of an individual row in the results for an HTML return type.


This is an abstract API to which data provider implementations conform to. For more information on the dojo.data APIs, visit: http://www.dojotoolkit.org/node/98

Function summary
Object getValue(Object item, String attribute, String defaultValue)
Retrieves the value of the named attribute on the given item.
Array getValues(Object item, String attribute)
Retrieves the values of the named attribute on the given item.
Array getAttributes(Object item)
Returns an array with all the attributes that this item has.
Boolean hasAttribute(Object item, String attribute)
Returns true if the given item has a value for the given attribute.
Boolean containsValue(Object item, String attribute, Object value)
Returns true if the given value is one of the values that getValues() would return.
Boolean isItem(Object something)
Returns whether *something* is an item and came from this store instance.
Boolean isItemLoaded(Object something)
Returns whether *something* is loaded in local memory.
void loadItem(Object keywordArgs)
Given an item, this method loads the item so that a subsequent call to store.isItemLoaded(item) returns true.
Object fetch(Object keywordArgs)
Given a query and set of defined options, such as a start and count of items to return, this method runs the query and makes the results available as data items.
Object getFeatures()
Returns a simple keyword value object that specifies what interface features the data store implements.
void close(Object request)
Instructs the store to close out any information associated with a particular request.
String getLabel(Object item)
Method to inspect the item and return a user-readable label for the item that provides a general description of what the item is.
Array getLabelAttributes(Object item)
Method to inspect the item and return an array of what attributes of the item were used to generate its label, if any attributes exist.

Function detail

getValue


getValues


getAttributes


hasAttribute


containsValue


isItem


isItemLoaded


loadItem


fetch


getFeatures


close


getLabel


getLabelAttributes