OSID - osid.recognition.AwardQuerySession Service Interface Definition

Interface	osid.recognition.AwardQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching `Award` objects. The search query is constructed using the `AwardQuery.` The award record `Type` also specifies the record for the award query. Awards may have a query record indicated by their respective record types. The query record is accessed via the `AwardQuery.` The returns in this session may not be cast directly to these interfaces.
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchAwards
Description	Tests if this user can perform `Award` 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 opt 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	useFederatedAcademyView
Description	Federates the view for methods in this session. A federated view will include awards in academies which are children of this academy in the academy hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAcademyView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.
Compliance	`mandatory`		This method is 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	getAwardsByQuery
Description	Gets a list of `Awards` matching the given search.
Parameters	`osid.recognition.AwardQuery`	`awardQuery`	the award query
Return	`osid.recognition.AwardList`		the returned `AwardList`
Errors	NULL_ARGUMENT		`awardQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`awardQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.