OSID - osid.recognition.ConvocationSmartAcademySession Service Interface Definition

Interface	osid.recognition.ConvocationSmartAcademySession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ConvocationQuery` can be retrieved from this session and mapped to this `Academy` to create a virtual collection of `Convocations.` The awards may be sequenced using the `ConvocationSearchOrder` from this session. This `Academy` has a default query that matches any convocation and a default search order that specifies no sequencing. The queries may be examined using a `ConvocationQueryInspector.` The query may be modified by converting the inspector back to a `ConvocationQuery.`
Method	getAcademyId
Description	Gets the `Academy` `Id` associated with this session.
Return	`osid.id.Id`		the `Academy Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAcademy
Description	Gets the `Academy` associated with this session.
Return	`osid.recognition.Academy`		the `Academy` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartAcademies
Description	Tests if this user can manage smart academies. 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 academy management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationQuery
Description	Gets a convocation query.
Return	`osid.recognition.ConvocationQuery`		the convocation query
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationSearchOrder
Description	Gets a convocation search order.
Return	`osid.recognition.ConvocationSearchOrder`		the convocation search order
Compliance	`mandatory`		This method must be implemented.
Method	applyConvocationQuery
Description	Applies a convocation query to this academy.
Parameters	`osid.recognition.ConvocationQuery`	`convocationQuery`	the convocation query
Errors	NULL_ARGUMENT		`convocationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`convocationQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectConvocationQuery
Description	Gets a convocation query inspector for this academy.
Return	`osid.recognition.ConvocationQueryInspector`		the convocation query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyConvocationSequencing
Description	Applies a convocation search order to this academy.
Parameters	`osid.recognition.ConvocationSearchOrder`	`convocationSearchOrder`	the convocation search order
Errors	NULL_ARGUMENT		`convocationSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`convocationSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationQueryFromInspector
Description	Gets a convocation query from an inspector.
Parameters	`osid.recognition.ConvocationQueryInspector`	`convocationQueryInspector`	a query inspector
Return	`osid.recognition.ConvocationQuery`		the convocation query
Errors	NULL_ARGUMENT		`convocationQueryInspector` is `null`
Errors	UNSUPPORTED		`convocationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.