Interface | osid.personnel.AppointmentSearchSession | ||
---|---|---|---|
Implements | osid.personnel.AppointmentQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Appointments may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getAppointmentSearch | ||
Description |
Gets an appointment search. | ||
Return | osid.personnel.AppointmentSearch | the appointment search | |
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentSearchOrder | ||
Description |
Gets an appointment search order. The | ||
Return | osid.personnel.AppointmentSearchOrder | the appointment search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.personnel.AppointmentQuery | appointmentQuery | the appointment query |
osid.personnel.AppointmentSearch | appointmentSearch | the appointment search | |
Return | osid.personnel.AppointmentSearchResults | the search results | |
Errors | NULL_ARGUMENT | appointmentQuery or appointmentSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | appointmentQuery or appointmentSearch is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentQueryFromInspector | ||
Description |
Gets an appointment query from an inspector. The
inspector is available from an | ||
Parameters | osid.personnel.AppointmentQueryInspector | appointmentQueryInspector | an appointment query inspector |
Return | osid.personnel.AppointmentQuery | the appointment query | |
Errors | NULL_ARGUMENT | appointmentQueryInspector is null | |
UNSUPPORTED | appointmentQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |