OSID - osid.learning.ActivitySmartObjectiveBankSession Service Interface Definition

Interface	osid.learning.ActivitySmartObjectiveBankSession
Implements	`osid.OsidSession`
Used By	`osid.learning.LearningManager`
Used By	`osid.learning.LearningProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `ActivityQuery` can be retrieved from this session and mapped to this `ObjectiveBank` to create a virtual collection of activities. The activities may be sequenced using the `ActivitySearchOrder` from this session. This `ObjectiveBank` has a default query that matches any activity and a default search order that specifies no sequencing. The queries may be examined using an `ActivityQueryInspector`. The query may be modified by converting the inspector back to an `ActivityQuery`.
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	getActivityQuery
Description	Gets an activity query.
Return	`osid.learning.ActivityQuery`		the activity query
Compliance	`mandatory`		This method must be implemented.
Method	getActivitySearchOrder
Description	Gets an activity search order.
Return	`osid.learning.ActivitySearchOrder`		the activity search order
Compliance	`mandatory`		This method must be implemented.
Method	applyActivityQuery
Description	Applies an activity query to this bank.
Parameters	`osid.learning.ActivityQuery`	`activityQuery`	the activity query
Errors	NULL_ARGUMENT		`activityQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`activityQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectActivityQuery
Description	Gets an activity query inspector for this objective bank.
Return	`osid.learning.ActivityQueryInspector`		the activity query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyActivitySequencing
Description	Applies an activity search order to this objective bank.
Parameters	`osid.learning.ActivitySearchOrder`	`activitySearchOrder`	the activity search order
Errors	NULL_ARGUMENT		`activitySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`activitySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActivityQueryFromInspector
Description	Gets an activity query from an inspector.
Parameters	`osid.learning.ActivityQueryInspector`	`activityQueryInspector`	an activity query inspector
Return	`osid.learning.ActivityQuery`		the activity query
Errors	NULL_ARGUMENT		`activityQueryInspector` is `null`
Errors	UNSUPPORTED		`activityQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.