OSID Logo
OSID Specifications
personnel package
Version 3.1.0
Interfaceosid.personnel.RealmSearch
Implementsosid.OsidSearch
Used Byosid.personnel.RealmSearchSession
Description

The search interface for governing realm searches.

MethodsearchAmongRealms
Description

Execute this search among the given list of realms.

Parametersosid.id.IdListrealmIds list of realms
ErrorsNULL_ARGUMENT realmIds is null
Compliancemandatory This method must be implemented.
MethodorderRealmResults
Description

Specify an ordering to the search results.

Parametersosid.personnel.RealmSearchOrderrealmSearchOrder realm search order
ErrorsNULL_ARGUMENT realmSearchOrder is null
UNSUPPORTED realmSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetRealmSearchRecord
Description

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

Parametersosid.type.TyperealmSearchRecordType a realm search record type
Returnosid.personnel.records.RealmSearchRecord the realm search record
ErrorsNULL_ARGUMENT realmSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(realmSearchRecordType) is false
Compliancemandatory This method must be implemented.