public interface AppointmentSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
AppointmentQueryInspector |
getAppointmentQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
AppointmentList |
getAppointments()
Gets the appointment list resulting from a search.
|
AppointmentSearchResultsRecord |
getAppointmentSearchResultsRecord(Type appointmentSearchRecordType)
Gets the record corresponding to the given appointment search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
AppointmentList getAppointments()
IllegalStateException
- the list has already been
retrievedmandatory
- This method must be implemented. AppointmentQueryInspector getAppointmentQueryInspector()
mandatory
- This method must be implemented. AppointmentSearchResultsRecord getAppointmentSearchResultsRecord(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.