Référence pour l'API OpenSearchStore d'IBM

Le magasin OpenSearch implémente uniquement l'API de lecture dojo.data. Pour plus d'informations sur l'API, reportez-vous à la documentation de référence suivante. Les informations contenues dans cette documentation proviennent du fichier dojo.data.api.Read et s'appliquent à tous les magasins. La seule restriction ayant trait au magasin OpenSearch concerne les attributs. Un seul attribut est défini pour les éléments du magasin OpenSearch. Cet attribut, intitulé content, représente le contenu des résultats de la recherche. Les résultats incluent l'élément de contenu d'un flux Atom, l'élément de description d'un flux RSS ainsi que le contenu HTML d'une ligne parmi les lignes de résultats HTML renvoyées.


Il s'agit d'une API abstraite qui sert de référence aux implémentations du fournisseur de données. Pour plus d'informations sur les API dojo.data, visitez le site : http://www.dojotoolkit.org/node/98

Résumé des fonctions
Objet getValue(Object item, String attribute, String defaultValue)
Permet d'extraire la valeur de l'attribut spécifié au niveau de l'élément.
Array getValues(Object item, String attribute)
Permet d'extraire les valeurs de l'attribut spécifié au niveau de l'élément.
Array getAttributes(Object item)
Renvoie un tableau qui contient l'ensemble des attributs de l'élément.
Booléen hasAttribute(Object item, String attribute)
Renvoie true si une valeur est affectée à l'attribut de l'élément.
Booléen containsValue(Object item, String attribute, Object value)
Renvoie true si la valeur indiquée fait partie des valeurs susceptibles d'être renvoyées par getValues().
Booléen isItem(Object something)
Indique si *something* est un élément et s'il provient de cette instance de magasin.
Booléen isItemLoaded(Object something)
Indique si *something* est chargé ou non dans la mémoire locale.
void loadItem(Object keywordArgs)
Cette méthode charge un élément de manière à ce que store.isItemLoaded(item) renvoie la valeur true lors d'un appel ultérieur.
Objet fetch(Object keywordArgs)
Si vous spécifiez une requête et définissez un ensemble d'options (par exemple, une option de démarrage (start) ou le nombre (count) d'éléments à renvoyer), cette méthode exécute la requête et les résultats sont disponibles sous forme d'éléments de données.
Objet getFeatures()
Renvoie un objet contenant un mot-clé simple et indiquant les fonctionnalités d'interface implémentées par le magasin de données.
void close(Object request)
Indique au magasin qu'il doit supprimer les informations associées à une demande particulière.
String (chaîne) getLabel(Object item)
Méthode permettant d'inspecter l'élément et de renvoyer un intitulé lisible qui décrit l'élément de façon générale.
Array getLabelAttributes(Object item)
Méthode permettant d'inspecter l'élément et de renvoyer un tableau récapitulatif des attributs éventuels, utilisés pour générer l'intitulé de l'élément.

Détails des fonctions

getValue


getValues


getAttributes


hasAttribute


containsValue


isItem


isItemLoaded


loadItem


fetch


getFeatures


close


getLabel


getLabelAttributes