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

Interface	osid.hold.rules.IssueProcessorSmartOublietteSession
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 `IssueProcessorQuery` can be retrieved from this session and mapped to this `Oubliette` to create a virtual collection of `IssueProcessors` . The issue processors may be sequenced using the `IssueProcessorSearchOrder` from this session. This `Oubliette` has a default query that matches any issue processor and a default search order that specifies no sequencing. The queries may be examined using an `IssueProcessorQueryInspector` . The query may be modified by converting the inspector back to an `IssueProcessorQuery` .
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.OublietteList`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartIssueProcessors
Description	Tests if this user can manage smart issue processors.. 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	getIssueProcessorQuery
Description	Gets an issue processor query.
Return	`osid.hold.rules.IssueProcessorQuery`		the issue processor query
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorSearchOrder
Description	Gets an issue processor search order.
Return	`osid.hold.rules.IssueProcessorSearchOrder`		the issue processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueProcessorQuery
Description	Applies an issue processor query to this oubliette.
Parameters	`osid.hold.rules.IssueProcessorQuery`	`issueProcessorQuery`	the issue processor query
Errors	NULL_ARGUMENT		`issueProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectIssueProcessorQuery
Description	Gets an issue processor query inspector for this oubliette.
Return	`osid.hold.rules.IssueProcessorQueryInspector`		the issue processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueProcessorSequencing
Description	Applies an issue processor search order to this oubliette.
Parameters	`osid.hold.rules.IssueProcessorSearchOrder`	`issueProcessorSearchOrder`	the issue processor search order
Errors	NULL_ARGUMENT		`issueProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorQueryFromInspector
Description	Gets an issue processor query from an inspector.
Parameters	`osid.hold.rules.IssueProcessorQueryInspector`	`issueProcessorQueryInspector`	an issue processor query inspector
Return	`osid.hold.rules.IssueProcessorQuery`		the issue processor query
Errors	NULL_ARGUMENT		`issueProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`issueProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.