OSID - osid.learning.ObjectiveSmartObjectiveBankSession Service Interface Definition

Interface	osid.learning.ObjectiveSmartObjectiveBankSession
Implements	`osid.OsidSession`
Used By	`osid.learning.LearningManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `ObjectiveQuery` can be retrieved from this session and mapped to this `ObjectiveBank` to create a virtual collection of `Objectives`. The objectives may be sequenced using the `ObjectiveSearchOrder` from this session. This `ObjectiveBank` has a default query that matches any objective and a default search order that specifies no sequencing. The queries may be examined using an `ObjectiveQueryInspector`. The query may be modified by converting the inspector back to an `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	canManageSmartObjectiveBanks
Description	Tests if this user can manage smart objective banks. A return of true does not guarantee successful assessment. 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 objective bank management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getObjectiveSearchOrder
Description	Gets an objective search order.
Return	`osid.learning.ObjectiveSearchOrder`		the objective search order
Compliance	`mandatory`		This method must be implemented.
Method	applyObjectiveQuery
Description	Applies an objective query to this bank.
Parameters	`osid.learning.ObjectiveQuery`	`objectiveQuery`	the objective query
Errors	NULL_ARGUMENT		`objectiveQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`objectiveQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectObjectiveQuery
Description	Gets an objective query inspector for this objective bank.
Return	`osid.learning.ObjectiveQueryInspector`		the objective query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyObjectiveSequencing
Description	Applies an objective search order to this objective bank.
Parameters	`osid.learning.ObjectiveSearchOrder`	`objectiveSearchOrder`	the objective search order
Errors	NULL_ARGUMENT		`objectiveSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`objectiveSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveQueryFromInspector
Description	Gets an objective query from an inspector.
Parameters	`osid.learning.ObjectiveQueryInspector`	`objectiveQueryInspector`	a query inspector
Return	`osid.learning.ObjectiveQuery`		the objective query
Errors	NULL_ARGUMENT		`objectiveQueryInspector` is `null`
Errors	UNSUPPORTED		`objectiveQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.