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

Interface	osid.hold.rules.IssueConstrainerSmartOublietteSession
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 `IssueConstrainerQu` ery can be retrieved from this session and mapped to this `Oubliette` to create a virtual collection of `IssueConstraine` rs. The issue constrainers may be sequenced using the `IssueConstrainerSearchOr` der from this session. This `Oubliette` has a default query that matches any issue constrainer and a default search order that specifies no sequencing. The queries may be examined using an `IssueConstrainerQueryInspecto` r. The query may be modified by converting the inspector back to an `IssueConstrainerQuery`.
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	canManageSmartIssueConstrainers
Description	Tests if this user can manage smart issue constrainers.. 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	getIssueConstrainerQuery
Description	Gets an issue constrainer query.
Return	`osid.hold.rules.IssueConstrainerQuery`		the issue constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerSearchOrder
Description	Gets an issue constrainer search order.
Return	`osid.hold.rules.IssueConstrainerSearchOrder`		the issue constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueConstrainerQuery
Description	Applies an issue constrainer query to this oubliette.
Parameters	`osid.hold.rules.IssueConstrainerQuery`	`issueConstrainerQuery`	the issue constrainer query
Errors	NULL_ARGUMENT		`issueConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectIssueConstrainerQuery
Description	Gets an issue constrainer query inspector for this oubliette.
Return	`osid.hold.rules.IssueConstrainerQueryInspector`		the issue constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueConstrainerSequencing
Description	Applies an issue constrainer search order to this oubliette.
Parameters	`osid.hold.rules.IssueConstrainerSearchOrder`	`issueConstrainerSearchOrder`	the issue constrainer search order
Errors	NULL_ARGUMENT		`issueConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerQueryFromInspector
Description	Gets an issue constrainer query from an inspector.
Parameters	`osid.hold.rules.IssueConstrainerQueryInspector`	`issueConstrainerQueryInspector`	an issue constrainer query inspector
Return	`osid.hold.rules.IssueConstrainerQuery`		the issue constrainer query
Errors	NULL_ARGUMENT		`issueConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`issueConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.