Interface StateSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StateSearch
extends OsidSearch

The search interface for governing state searches.

Method Summary

Modifier and Type	Method	Description
StateSearchRecord	getStateSearchRecord(Type stateSearchRecordType)	Gets the state seaqrch record corresponding to the given state search record Type.
void	orderStateResults(StateSearchOrder stateSearchOrder)	Specify an ordering to the search results.
void	searchAmongStates(IdList stateIds)	Execute this search among the given list of states.

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

searchAmongStates

void searchAmongStates(IdList stateIds)

Execute this search among the given list of states.

Parameters:

stateIds - list of state Ids

Throws:

NullArgumentException - stateIds is null

Compliance:

mandatory - This method must be implemented.

orderStateResults

void orderStateResults(StateSearchOrder stateSearchOrder)

Specify an ordering to the search results.

Parameters:

stateSearchOrder - state search order

Throws:

NullArgumentException - stateSearchOrder is null

UnsupportedException - stateSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStateSearchRecord

StateSearchRecord getStateSearchRecord(Type stateSearchRecordType)
                                throws OperationFailedException

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

Parameters:

stateSearchRecordType - a state search record type

Returns:

the state search record

Throws:

NullArgumentException - stateSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(stateSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.