OSID Logo
OSID Specifications
personnel package
Version 3.1.0
Interfaceosid.personnel.AppointmentSearch
Implementsosid.OsidSearch
Used Byosid.personnel.AppointmentSearchSession
Description

The search interface for governing appointment searches.

MethodsearchAmongAppointments
Description

Execute this search among the given list of appointments.

Parametersosid.id.IdListappointmentIds list of appointments
ErrorsNULL_ARGUMENT appointmentIds is null
Compliancemandatory This method must be implemented.
MethodorderAppointmentResults
Description

Specify an ordering to the search results.

Parametersosid.personnel.AppointmentSearchOrderappointmentSearchOrder appointment search order
ErrorsNULL_ARGUMENT appointmentSearchOrder is null
UNSUPPORTED appointmentSearchOrder is not of this service
Compliancemandatory This 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.TypeappointmentSearchRecordType an appointment search record type
Returnosid.personnel.records.AppointmentSearchRecord the appointment search record
ErrorsNULL_ARGUMENT appointmentSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(appointmentSearchRecordType) is false
Compliancemandatory This method must be implemented.