OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PersonSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetPersons
Description

Gets the person list resulting from a search.

Returnosid.personnel.PersonListthe person list
ErrorsILLEGAL_STATEthe list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPersonQueryInspector
Description

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

Returnosid.personnel.PersonQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypepersonSearchRecordTypea person search record type
Returnosid.personnel.records.PersonSearchResultsRecordthe person search results record
ErrorsNULL_ARGUMENT personSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(personSearchRecordType) is false
CompliancemandatoryThis method must be implemented.