public interface StateSearch extends OsidSearch
The search interface for governing state searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongStates(IdList stateIds)
stateIds
- list of state Ids
NullArgumentException
- stateIds
is
null
mandatory
- This method must be implemented. void orderStateResults(StateSearchOrder stateSearchOrder)
stateSearchOrder
- state search orderNullArgumentException
- stateSearchOrder
is null
UnsupportedException
- stateSearchOrder
is not of this servicemandatory
- This method must be implemented. StateSearchRecord getStateSearchRecord(Type stateSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.stateSearchRecordType
- a state search record typeNullArgumentException
- stateSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordTypeType(stateSearchRecordType)
is
false
mandatory
- This method must be implemented.