OSID Logo
OSID Specifications
personnel package
Version 3.1.0
Interfaceosid.personnel.PersonSearchResults
Implementsosid.OsidSearchResults
Used Byosid.personnel.PersonSearchSession
Description

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

MethodgetPersons
Description

Gets the person list resulting from a search.

Returnosid.personnel.PersonList the person list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetPersonQueryInspector
Description

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

Returnosid.personnel.PersonQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetPersonSearchResultsRecord
Description

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

Parametersosid.type.TypepersonSearchRecordType a person search record type
Returnosid.personnel.records.PersonSearchResultsRecord the person search results record
ErrorsNULL_ARGUMENT personSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(personSearchRecordType) is false
Compliancemandatory This method must be implemented.