OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PersonSearch
Implementsosid.OsidSearch
Description

The search interface for governing person searches.

MethodsearchAmongPersons
Description

Execute this search among the given list of persons.

Parametersosid.id.IdListpersonIdslist of persons
ErrorsNULL_ARGUMENT personIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPersonResults
Description

Specify an ordering to the search results.

Parametersosid.personnel.PersonSearchOrderpersonSearchOrderperson search order
ErrorsNULL_ARGUMENT personSearchOrder is null
UNSUPPORTED personSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPersonSearchRecord
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.PersonSearchRecordthe person search record
ErrorsNULL_ARGUMENT personSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(personSearchRecordType) is false
CompliancemandatoryThis method must be implemented.