Interface StoreSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StoreSearch
extends OsidSearch

The search interface for governing store searches.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongStores

void searchAmongStores(IdList storeIds)

Execute this search among the given list of stores.

Parameters:

storeIds - list of stores

Throws:

NullArgumentException - storeIds is null

Compliance:

mandatory - This method must be implemented.

orderStoreResults

void orderStoreResults(StoreSearchOrder storesearchOrder)

Specify an ordering to the search results.

Parameters:

storesearchOrder - store search order

Throws:

NullArgumentException - storesearchOrder is null

UnsupportedException - storesearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStoreSearchRecord

StoreSearchRecord getStoreSearchRecord(Type storeSearchRecordType)
                                throws OperationFailedException

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.

Parameters:

storeSearchRecordType - a store search record type

Returns:

the store search record

Throws:

NullArgumentException - storesearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(storesearchRecordType) is false

Compliance:

mandatory - This method must be implemented.