public interface AppointmentSearch extends OsidSearch
The search interface for governing appointment searches.
Modifier and Type | Method and Description |
---|---|
AppointmentSearchRecord |
getAppointmentSearchRecord(Type appointmentSearchRecordType)
Gets the record corresponding to the given appointment search record
Type. |
void |
orderAppointmentResults(AppointmentSearchOrder appointmentSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongAppointments(IdList appointmentIds)
Execute this search among the given list of appointments.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAppointments(IdList appointmentIds)
appointmentIds
- list of appointmentsNullArgumentException
- appointmentIds
is null
mandatory
- This method must be implemented. void orderAppointmentResults(AppointmentSearchOrder appointmentSearchOrder)
appointmentSearchOrder
- appointment search orderNullArgumentException
- appointmentSearchOrder
is null
UnsupportedException
- appointmentSearchOrder
is not of this servicemandatory
- This method must be implemented. AppointmentSearchRecord getAppointmentSearchRecord(Type appointmentSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.appointmentSearchRecordType
- an appointment search record typeNullArgumentException
-
appointmentSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(appointmentSearchRecordType)
is
false
mandatory
- This method must be implemented.