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

The search interface for governing appointment searches.

MethodsearchAmongAppointments
Description

Execute this search among the given list of appointments.

Parametersosid.id.IdListappointmentIdslist of appointments
ErrorsNULL_ARGUMENT appointmentIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAppointmentResults
Description

Specify an ordering to the search results.

Parametersosid.personnel.AppointmentSearchOrderappointmentSearchOrderappointment search order
ErrorsNULL_ARGUMENT appointmentSearchOrder is null
UNSUPPORTED appointmentSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentSearchRecord
Description

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

Parametersosid.type.TypeappointmentSearchRecordTypean appointment search record type
Returnosid.personnel.records.AppointmentSearchRecordthe appointment search record
ErrorsNULL_ARGUMENT appointmentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(appointmentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.