OSID Logo
OSID Specifications
process package
Version 3.1.0
Interfaceosid.process.StateSearch
Implementsosid.OsidSearch
Used Byosid.process.StateSearchSession
Description

The search interface for governing state searches.

MethodsearchAmongStates
Description

Execute this search among the given list of states.

Parametersosid.id.IdListstateIds list of state Ids
ErrorsNULL_ARGUMENT stateIds is null
Compliancemandatory This method must be implemented.
MethodorderStateResults
Description

Specify an ordering to the search results.

Parametersosid.process.StateSearchOrderstateSearchOrder state search order
ErrorsNULL_ARGUMENT stateSearchOrder is null
UNSUPPORTED stateSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetStateSearchRecord
Description

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.

Parametersosid.type.TypestateSearchRecordType a state search record type
Returnosid.process.records.StateSearchRecord the state search record
ErrorsNULL_ARGUMENT stateSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(stateSearchRecordType) is false
Compliancemandatory This method must be implemented.