OSID Logo
OSID Specifications
personnel package
Version 3.1.0
Interfaceosid.personnel.RealmSearchResults
Implementsosid.OsidSearchResults
Used Byosid.personnel.RealmSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetRealms
Description

Gets the realm list resulting from a search.

Returnosid.personnel.RealmList the realm list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetRealmQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.personnel.RealmQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetRealmSearchResultsRecord
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.RealmSearchResultsRecord the realm search results record
ErrorsNULL_ARGUMENT realmSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(realmSearchRecordType) is false
Compliancemandatory This method must be implemented.