OSID - osid.recognition.ConvocationQuerySession Service Interface Definition

Interface	osid.recognition.ConvocationQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching `Convocation` objects. The search query is constructed using the `ConvocationQuery.` The award record `Type` also specifies the record for the award query. Convocations may have a query record indicated by their respective record types. The query record is accessed via the `ConvocationQuery.` 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	canSearchConvocations
Description	Tests if this user can perform susbcription 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 not wish 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 convocations 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	getConvocationQuery
Description	Gets a convocation query.
Return	`osid.recognition.ConvocationQuery`		the convocation query
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationsByQuery
Description	Gets a list of convocations matching the given convocation query.
Parameters	`osid.recognition.ConvocationQuery`	`convocationQuery`	the convocation query
Return	`osid.recognition.ConvocationList`		the returned `ConvocationList`
Errors	NULL_ARGUMENT		`convocationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`convocationQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.