OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.StateSearch
Implementsosid.OsidSearch
Description

The search interface for governing state searches.

MethodsearchAmongStates
Description

Execute this search among the given list of states.

Parametersosid.id.IdListstateIdslist of state Ids
ErrorsNULL_ARGUMENT stateIds is null
CompliancemandatoryThis method must be implemented.
MethodorderStateResults
Description

Specify an ordering to the search results.

Parametersosid.process.StateSearchOrderstateSearchOrderstate search order
ErrorsNULL_ARGUMENT stateSearchOrder is null
UNSUPPORTED stateSearchOrder is not of this service
CompliancemandatoryThis 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.TypestateSearchRecordTypea state search record type
Returnosid.process.records.StateSearchRecordthe state search record
ErrorsNULL_ARGUMENT stateSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(stateSearchRecordType) is false
CompliancemandatoryThis method must be implemented.