OSID - osid.hold.rules.IssueEnablerSmartOublietteSession Service Interface Definition

Interface	osid.hold.rules.IssueEnablerSmartOublietteSession
Implements	`osid.OsidSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `IssueEnablerQuery` can be retrieved from this session and mapped to this `Oubliette` to create a virtual collection of `IssueEnablers` . The issue enablers may be sequenced using the `IssueEnablerSearchOrder` from this session. This `Oubliette` has a default query that matches any issue enabler and a default search order that specifies no sequencing. The queries may be examined using an `IssueEnablerQueryInspector` . The query may be modified by converting the inspector back to an `IssueEnablerQuery` .
Method	getOublietteId
Description	Gets the `Oubliette` `Id` associated with this session.
Return	`osid.id.Id`		the `Oubliette Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOubliette
Description	Gets the `Oubliette` associated with this session.
Return	`osid.hold.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartIssueEnablers
Description	Tests if this user can manage smart issue enablers.. A return of true does not guarantee successful authorization. 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 oubliette management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablerQuery
Description	Gets an issue enabler query.
Return	`osid.hold.rules.IssueEnablerQuery`		the issue enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablerSearchOrder
Description	Gets an issue enabler search order.
Return	`osid.hold.rules.IssueEnablerSearchOrder`		the issue enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueEnablerQuery
Description	Applies an issue enabler query to this oubliette.
Parameters	`osid.hold.rules.IssueEnablerQuery`	`issueEnablerQuery`	the issue enabler query
Errors	NULL_ARGUMENT		`issueEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectIssueEnablerQuery
Description	Gets an issue enabler query inspector for this oubliette.
Return	`osid.hold.rules.IssueEnablerQueryInspector`		the issue enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueEnablerSequencing
Description	Applies an issue enabler search order to this oubliette.
Parameters	`osid.hold.rules.IssueEnablerSearchOrder`	`issueEnablerSearchOrder`	the issue enabler search order
Errors	NULL_ARGUMENT		`issueEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablerQueryFromInspector
Description	Gets an issue enabler query from an inspector.
Parameters	`osid.hold.rules.IssueEnablerQueryInspector`	`issueEnablerQueryInspector`	an issue enabler query inspector
Return	`osid.hold.rules.IssueEnablerQuery`		the issue enabler query
Errors	NULL_ARGUMENT		`issueEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`issueEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.