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

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

MethodgetAppointments
Description

Gets the appointment list resulting from a search.

Returnosid.personnel.AppointmentListthe appointment list
ErrorsILLEGAL_STATEthe list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentQueryInspector
Description

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

Returnosid.personnel.AppointmentQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentSearchResultsRecord
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.AppointmentSearchResultsRecordthe appointment search results record
ErrorsNULL_ARGUMENT appointmentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(appointmentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.