OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.AppointmentSearchSession
Implementsosid.personnel.AppointmentQuerySession
Description

This session provides methods for searching Appointment objects. The search query is constructed using the AppointmentQuery. The appointment record Type also specifies the record for the appointment query.

getAppointmentsByQuery() is the basic search method and returns a list of Appointment elements. A more advanced search may be performed with getAppointmentsBySearch(). It accepts an AppointmentSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAppointmentsBySearch() returns an AppointmentSearchResults that can be used to access the resulting AppointmentList or be used to perform a search within the result set through AppointmentSearch.

This session defines views that offer differing behaviors for searching.

  • federated realm view: searches include appointments in realms of which this realm is a ancestor in the realm hierarchy
  • isolated realm view: searches are restricted to appointments in this realm

Appointments may have a query record indicated by their respective record types. The query record is accessed via the AppointmentQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetAppointmentSearch
Description

Gets an appointment search.

Returnosid.personnel.AppointmentSearchthe appointment search
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentSearchOrder
Description

Gets an appointment search order. The AppointmentSearchOrder is supplied to an AppointmentSearch to specify the ordering of results.

Returnosid.personnel.AppointmentSearchOrderthe appointment search order
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentsBySearch
Description

Gets the search results matching the given search.

Parametersosid.personnel.AppointmentQueryappointmentQuerythe appointment query
osid.personnel.AppointmentSearchappointmentSearchthe appointment search
Returnosid.personnel.AppointmentSearchResultsthe search results
ErrorsNULL_ARGUMENT appointmentQuery or appointmentSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED appointmentQuery or appointmentSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentQueryFromInspector
Description

Gets an appointment query from an inspector. The inspector is available from an AppointmentSearchResults.

Parametersosid.personnel.AppointmentQueryInspectorappointmentQueryInspectoran appointment query inspector
Returnosid.personnel.AppointmentQuerythe appointment query
ErrorsNULL_ARGUMENT appointmentQueryInspector is null
UNSUPPORTED appointmentQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.