OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.StoreSearchSession
Implementsosid.ordering.StoreQuerySession
Description

This session provides methods for searching Store objects. The search query is constructed using the StoreQuery. The store record Type also specifies the record for the store query.

getStoresByQuery() is the basic search method and returns a list of Store elements. A more advanced search may be performed with getStoresBySearch(). It accepts a StoreSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getStoresBySearch() returns a StoreSearchResults that can be used to access the resulting StoreList or be used to perform a search within the result set through StoreSearch.

Stores may have a query record indicated by their respective record types. The query record is accessed via the StoreQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetStoreSearch
Description

Gets a store search.

Returnosid.ordering.StoreSearchthe store search
CompliancemandatoryThis method must be implemented.
MethodgetStoreSearchOrder
Description

Gets a store search order. The StoreSearchOrder is supplied to a StoreSearch to specify the ordering of results.

Returnosid.ordering.StoreSearchOrderthe store search order
CompliancemandatoryThis method must be implemented.
MethodgetStoresBySearch
Description

Gets the search results matching the given search.

Parametersosid.ordering.StoreQuerystoreQuerythe store query
osid.ordering.StoreSearchstoreSearchthe store search
Returnosid.ordering.StoreSearchResultsthe store search results
ErrorsNULL_ARGUMENT storeQuery or storeSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED storeQuery or storeSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStoreQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an StoreSearchResults.

Parametersosid.ordering.StoreQueryInspectorstoreQueryInspectora query inspector
Returnosid.ordering.StoreQuerythe store query
ErrorsNULL_ARGUMENT storeQueryInspector is null
UNSUPPORTED storeQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.