Interface | osid.personnel.AppointmentSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing appointment searches. | ||
Method | searchAmongAppointments | ||
Description |
Execute this search among the given list of appointments. | ||
Parameters | osid.id.IdList | appointmentIds | list of appointments |
Errors | NULL_ARGUMENT | appointmentIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderAppointmentResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.personnel.AppointmentSearchOrder | appointmentSearchOrder | appointment search order |
Errors | NULL_ARGUMENT | appointmentSearchOrder is null | |
UNSUPPORTED | appointmentSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentSearchRecord | ||
Description |
Gets the record corresponding to the given appointment
search record | ||
Parameters | osid.type.Type | appointmentSearchRecordType | an appointment search record type |
Return | osid.personnel.records.AppointmentSearchRecord | the appointment search record | |
Errors | NULL_ARGUMENT | appointmentSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(appointmentSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |