OSID Logo
OSID Specifications
personnel package
Version 3.1.0
Interfaceosid.personnel.PersonSearch
Implementsosid.OsidSearch
Used Byosid.personnel.PersonSearchSession
Description

The search interface for governing person searches.

MethodsearchAmongPersons
Description

Execute this search among the given list of persons.

Parametersosid.id.IdListpersonIds list of persons
ErrorsNULL_ARGUMENT personIds is null
Compliancemandatory This method must be implemented.
MethodorderPersonResults
Description

Specify an ordering to the search results.

Parametersosid.personnel.PersonSearchOrderpersonSearchOrder person search order
ErrorsNULL_ARGUMENT personSearchOrder is null
UNSUPPORTED personSearchOrder is not of this service
Compliancemandatory This 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.TypepersonSearchRecordType a person search record type
Returnosid.personnel.records.PersonSearchRecord the person search record
ErrorsNULL_ARGUMENT personSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(personSearchRecordType) is false
Compliancemandatory This method must be implemented.