| Interface | osid.process.StateSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing state searches. | ||
| Method | searchAmongStates | ||
| Description |
Execute this search among the given list of states. | ||
| Parameters | osid.id.IdList | stateIds | list of state Ids |
| Errors | NULL_ARGUMENT | stateIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderStateResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.process.StateSearchOrder | stateSearchOrder | state search order |
| Errors | NULL_ARGUMENT | stateSearchOrder is null | |
| UNSUPPORTED | stateSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getStateSearchRecord | ||
| Description |
Gets the state seaqrch record corresponding to the
given state search record | ||
| Parameters | osid.type.Type | stateSearchRecordType | a state search record type |
| Return | osid.process.records.StateSearchRecord | the state search record | |
| Errors | NULL_ARGUMENT | stateSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordTypeType(stateSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |