OSID Logo
OSID Specifications
personnel package
Version 3.0.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.IdListrealmIdslist of realms
ErrorsNULL_ARGUMENTrealmIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRealmResults
Description

Specify an ordering to the search results.

Parametersosid.personnel.RealmSearchOrderrealmSearchOrderrealm search order
ErrorsNULL_ARGUMENTrealmSearchOrder is null
UNSUPPORTEDrealmSearchOrder is not of this service
CompliancemandatoryThis 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.TyperealmSearchRecordTypea realm search record type
Returnosid.personnel.records.RealmSearchRecordthe realm search record
ErrorsNULL_ARGUMENTrealmSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(realmSearchRecordType) is false
CompliancemandatoryThis method must be implemented.