OSID - osid.learning.ObjectiveQuerySession Service Interface Definition

Interface	osid.learning.ObjectiveQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching `Objective` objects. The search query is constructed using the `ObjectiveQuery.` The objective record `Type` also specifies the record for the objective query. This session defines views that offer differing behaviors for searching. federated objective bank view: searches include objectives in objective banks of which this objective bank is a ancestor in the objective bank hierarchy isolated objective bank view: searches are restricted to objectives in this objective bank Objectives may have a query record indicated by their respective record types. The query record is accessed via the `ObjectiveQuery.`
Method	getObjectiveBankId
Description	Gets the `ObjectiveBank` `Id` associated with this session.
Return	`osid.id.Id`		the `ObjectiveBank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBank
Description	Gets the `ObjectiveBank` associated with this session.
Return	`osid.learning.ObjectiveBank`		the `ObjectiveBank` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchObjectives
Description	Tests if this user can perform `Objectives` 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	useFederatedObjectiveBankView
Description	Federates the view for methods in this session. A federated view will include objectives in objective banks which are children of this objective bank in the objective bank hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedObjectiveBankView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this objective bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	getObjectiveQuery
Description	Gets an objective query.
Return	`osid.learning.ObjectiveQuery`		the objective query
Compliance	`mandatory`		This method must be implemented.
Method	getObjectivesByQuery
Description	Gets a list of `Objectives` matching the given objective query.
Parameters	`osid.learning.ObjectiveQuery`	`objectiveQuery`	the objective query
Return	`osid.learning.ObjectiveList`		the returned `ObjectiveList`
Errors	NULL_ARGUMENT		`objectiveQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`objectiveQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.