OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.StoreSearch
Implementsosid.OsidSearch
Description

The search interface for governing store searches.

MethodsearchAmongStores
Description

Execute this search among the given list of stores.

Parametersosid.id.IdListstoreIdslist of stores
ErrorsNULL_ARGUMENT storeIds is null
CompliancemandatoryThis method must be implemented.
MethodorderStoreResults
Description

Specify an ordering to the search results.

Parametersosid.ordering.StoreSearchOrderstoresearchOrderstore search order
ErrorsNULL_ARGUMENT storesearchOrder is null
UNSUPPORTED storesearchOrder is not of this service
CompliancemandatoryThis 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.TypestoreSearchRecordTypea store search record type
Returnosid.ordering.records.StoreSearchRecordthe store search record
ErrorsNULL_ARGUMENT storesearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(storesearchRecordType) is false
CompliancemandatoryThis method must be implemented.