public interface StoreSearch extends OsidSearch
The search interface for governing store searches.
Modifier and Type | Method and Description |
---|---|
StoreSearchRecord |
getStoreSearchRecord(Type storeSearchRecordType)
Gets the store search record corresponding to the given store search
record
Type. |
void |
orderStoreResults(StoreSearchOrder storesearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongStores(IdList storeIds)
Execute this search among the given list of stores.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongStores(IdList storeIds)
storeIds
- list of storesNullArgumentException
- storeIds
is
null
mandatory
- This method must be implemented. void orderStoreResults(StoreSearchOrder storesearchOrder)
storesearchOrder
- store search orderNullArgumentException
- storesearchOrder
is null
UnsupportedException
- storesearchOrder
is not of this servicemandatory
- This method must be implemented. StoreSearchRecord getStoreSearchRecord(Type storeSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.storeSearchRecordType
- a store search record typeNullArgumentException
- storesearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(storesearchRecordType)
is false
mandatory
- This method must be implemented.