OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.StoreSearch
Implementsosid.OsidSearch
Used Byosid.ordering.StoreSearchSession
Description

The search interface for governing store searches.

MethodsearchAmongStores
Description

Execute this search among the given list of stores.

Parametersosid.id.IdListstoreIds list of stores
ErrorsNULL_ARGUMENT storeIds is null
Compliancemandatory This method must be implemented.
MethodorderStoreResults
Description

Specify an ordering to the search results.

Parametersosid.ordering.StoreSearchOrderstoresearchOrder store search order
ErrorsNULL_ARGUMENT storesearchOrder is null
UNSUPPORTED storesearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetStoreSearchRecord
Description

Gets the store search record corresponding to the given store search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypestoreSearchRecordType a store search record type
Returnosid.ordering.records.StoreSearchRecord the store search record
ErrorsNULL_ARGUMENT storesearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(storesearchRecordType) is false
Compliancemandatory This method must be implemented.