OSID - osid.learning.ProficiencySmartObjectiveBankSession Service Interface Definition

Interface	osid.learning.ProficiencySmartObjectiveBankSession
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. A `ProficiencyQuery` can be retrieved from this session and mapped to this `ObjectiveBank` to create a virtual collection of `Proficiencies`. The proficiencies may be sequenced using the `ProficiencySearchOrder` from this session. This `ObjectiveBank` has a default query that matches any proficiency and a default search order that specifies no sequencing. The queries may be examined using a `ProficiencyQueryInspector`. The query may be modified by converting the inspector back to a `ProficiencyQuery`.
Method	getObjectiveBankId
Description	Gets the `Familt` `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 obective bank
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 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 smart operations.
Return	`boolean`		`false` if smart objective bank methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencyQuery
Description	Gets a proficiency query.
Return	`osid.learning.ProficiencyQuery`		the proficiency query
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencySearchOrder
Description	Gets a proficiency search order.
Return	`osid.learning.ProficiencySearchOrder`		the proficiency search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProficiencyQuery
Description	Applies a proficiency query to this objective bank.
Parameters	`osid.learning.ProficiencyQuery`	`proficiencyQuery`	the proficiency query
Errors	NULL_ARGUMENT		`proficiencyQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`proficiencyQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProficiencyQuery
Description	Gets a proficiency query inspector for this objective bank.
Return	`osid.learning.ProficiencyQueryInspector`		the proficiency query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProficiencySequencing
Description	Applies a proficiency search order to this objective bank.
Parameters	`osid.learning.ProficiencySearchOrder`	`proficiencySearchOrder`	the proficiency search order
Errors	NULL_ARGUMENT		`proficiencySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`proficiencySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencyQueryFromInspector
Description	Gets a proficiency query from an inspector.
Parameters	`osid.learning.ProficiencyQueryInspector`	`proficiencyQueryInspector`	a proficiency query inspector
Return	`osid.learning.ProficiencyQuery`		the proficiency query
Errors	NULL_ARGUMENT		`relatinshipQueryInspector` is `null`
Errors	UNSUPPORTED		`proficiencyQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.