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

Interface	osid.hold.rules.IssueProcessorEnablerSmartOublietteSession
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 `IssueProcessorEnablerQuery` can be retrieved from this session and mapped to this `Oubliette` to create a virtual collection of `IssueProcessorEnablers` . The issue processor enablers may be sequenced using the `IssueProcessorEnablerSearchOrder` from this session. This `Oubliette` has a default query that matches any issue processor enabler and a default search order that specifies no sequencing. The queries may be examined using an `IssueProcessorEnablerQueryInspector` . The query may be modified by converting the inspector back to an `IssueProcessorEnablerQuery` .
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	canManageSmartOubliettes
Description	Tests if this user can manage smart oubliettes. 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	getIssueProcessorEnablerQuery
Description	Gets an issue processor enabler query.
Return	`osid.hold.rules.IssueProcessorEnablerQuery`		the issue processor enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorEnablerSearchOrder
Description	Gets an issue processor enabler search order.
Return	`osid.hold.rules.IssueProcessorEnablerSearchOrder`		the issue processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueProcessorEnablerQuery
Description	Applies an issue processor enabler query to this oubliette.
Parameters	`osid.hold.rules.IssueProcessorEnablerQuery`	`issueProcessorEnablerQuery`	the issue processot enabler query
Errors	NULL_ARGUMENT		`issueProcessorEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueProcessorEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectIssueProcessorEnablerQuery
Description	Gets an issue processor enabler query inspector for this oubliette.
Return	`osid.hold.rules.IssueProcessorEnablerQueryInspector`		the issue processor enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueProcessorEnablerSequencing
Description	Applies an issue processor enabler search order to this oubliette.
Parameters	`osid.hold.rules.IssueProcessorEnablerSearchOrder`	`issueProcessorEnablerSearchOrder`	the issue processor enabler search order
Errors	NULL_ARGUMENT		`issueProcessorEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueProcessorEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorEnablerQueryFromInspector
Description	Gets an issue processor enabler query from an inspector.
Parameters	`osid.hold.rules.IssueProcessorEnablerQueryInspector`	`issueProcessorEnablerQueryInspector`	an issue processor enabler query inspector
Return	`osid.hold.rules.IssueProcessorEnablerQuery`		the issue processor enabler query
Errors	NULL_ARGUMENT		`issueProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`issueProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.