OSID - osid.personnel.AppointmentSearchSession Service Interface Definition

Interface	osid.personnel.AppointmentSearchSession
Implements	`osid.personnel.AppointmentQuerySession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
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 an 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.
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 `AppointmentSearchOrder` is supplied to an `AppointmentSearch` to specify the ordering of results.
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
Parameters	`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 `AppointmentSearchResults`.
Parameters	`osid.personnel.AppointmentQueryInspector`	`appointmentQueryInspector`	an appointment query inspector
Return	`osid.personnel.AppointmentQuery`		the appointment query
Errors	NULL_ARGUMENT		`appointmentQueryInspector` is `null`
Errors	UNSUPPORTED		`appointmentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.