OSID - osid.personnel.AppointmentSmartRealmSession Service Interface Definition

Interface	osid.personnel.AppointmentSmartRealmSession
Implements	`osid.OsidSession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `AppointmentQuery` can be retrieved from this session and mapped to this `Realm` to create a virtual collection of `Appointments`. The appointments may be sequenced using the `AppointmentSearchOrder` from this session. This `Realm` has a default query that matches any appointment and a default search order that specifies no sequencing. The queries may be examined using an `AppointmentQueryInspector`. The query may be modified by converting the inspector back to an `AppointmentQuery`.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartRealms
Description	Tests if this user can manage smart realms. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart realm management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getAppointmentSearchOrder
Description	Gets an appointment search order.
Return	`osid.personnel.AppointmentSearchOrder`		the appointment search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAppointmentQuery
Description	Applies an appointment query to this realm.
Parameters	`osid.personnel.AppointmentQuery`	`appointmentQuery`	the appointment query
Errors	NULL_ARGUMENT		`appointmentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`appointmentQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAppointmentQuery
Description	Gets an appointment query inspector for this realm.
Return	`osid.personnel.AppointmentQueryInspector`		the appointment query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAppointmentSequencing
Description	Applies an appointment search order to this realm.
Parameters	`osid.personnel.AppointmentSearchOrder`	`appointmentSearchOrder`	the appointment search order
Errors	NULL_ARGUMENT		`appointmentSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`appointmentSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAppointmentQueryFromInspector
Description	Gets an appointment query from an inspector.
Parameters	`osid.personnel.AppointmentQueryInspector`	`appointmentQueryInspector`	a 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.