OSID - osid.personnel.AppointmentQuerySession Service Interface Definition

Interface	osid.personnel.AppointmentQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for querying `Appointment` objects. The search query is constructed using the `AppointmentQuery.` This session defines views that offer differing behaviors for searching. federated realm view: searches include appointments in realms of which this realm is a 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	getRealmId
Description	Gets the `Realm` `Id` associated with this session.
Return	`osid.id.Id`		the `Realm Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRealm
Description	Gets the `Realm` associated with this session.
Return	`osid.personnel.Realm`		the realm
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchAppointments
Description	Tests if this user can perform `Appointment` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may wish not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedRealmView
Description	Federates the view for methods in this session. A federated view will include appointments in realms which are children of this realm in the realm hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedRealmView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this realm only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAppointmentQuery
Description	Gets an appointment query.
Return	`osid.personnel.AppointmentQuery`		the appointment query
Compliance	`mandatory`		This method must be implemented.
Method	getAppointmentsByQuery
Description	Gets a list of appointments matching the given appointment query.
Parameters	`osid.personnel.AppointmentQuery`	`appointmentQuery`	the appointment query
Return	`osid.personnel.AppointmentList`		the returned `AppointmentList`
Errors	NULL_ARGUMENT		`appointmentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`appointmentQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.