OSID - osid.recognition.AwardSmartAcademySession Service Interface Definition

Interface	osid.recognition.AwardSmartAcademySession
Implements	`osid.OsidSession`
Used By	`osid.recognition.RecognitionManager`
Used By	`osid.recognition.RecognitionProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `AwardQuery` can be retrieved from this session and mapped to this `Academy` to create a virtual collection of `Awards`. The awards may be sequenced using the `AwardSearchOrder` from this session. This `Academy` has a default query that matches any award and a default search order that specifies no sequencing. The queries may be examined using an `AwardQueryInspector`. The query may be modified by converting the inspector back to an `AwardQuery`.
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	getAwardQuery
Description	Gets an award query.
Return	`osid.recognition.AwardQuery`		the award query
Compliance	`mandatory`		This method must be implemented.
Method	getAwardSearchOrder
Description	Gets an award search order.
Return	`osid.recognition.AwardSearchOrder`		the award search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAwardQuery
Description	Applies an award query to this academy.
Parameters	`osid.recognition.AwardQuery`	`awardQuery`	the award query
Errors	NULL_ARGUMENT		`awardQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`awardQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAwardQuery
Description	Gets an award query inspector for this academy.
Return	`osid.recognition.AwardQueryInspector`		the award query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAwardSequencing
Description	Applies an award search order to this academy.
Parameters	`osid.recognition.AwardSearchOrder`	`awardSearchOrder`	the award search order
Errors	NULL_ARGUMENT		`awardSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`awardSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAwardQueryFromInspector
Description	Gets an award query from an inspector.
Parameters	`osid.recognition.AwardQueryInspector`	`awardQueryInspector`	a query inspector
Return	`osid.recognition.AwardQuery`		the award query
Errors	NULL_ARGUMENT		`awardQueryInspector` is `null`
Errors	UNSUPPORTED		`awardQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.