OSID - osid.hold.IssueSmartOublietteSession Service Interface Definition

Interface	osid.hold.IssueSmartOublietteSession
Implements	`osid.OsidSession`
Used By	`osid.hold.HoldManager`
Used By	`osid.hold.HoldProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `IssueQuery` can be retrieved from this session and oublietteped to this `Oubliette` to create a virtual collection of `Issues`. The issues may be sequenced using the `IssueSearchOrder` from this session. This `Oubliette` has a default query that matches any issue and a default search order that specifies no sequencing. The queries may be examined using an `IssueQueryInspector`. The query may be modified by converting the inspector back to an `IssueQuery`.
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	getIssueQuery
Description	Gets an issue query.
Return	`osid.hold.IssueQuery`		the issue query
Compliance	`mandatory`		This method must be implemented.
Method	getIssueSearchOrder
Description	Gets an issue search order.
Return	`osid.hold.IssueSearchOrder`		the issue search order
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueQuery
Description	Applies an issue query to this oubliette.
Parameters	`osid.hold.IssueQuery`	`issueQuery`	the issue query
Errors	NULL_ARGUMENT		`issueQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecIssueQuery
Description	Gets an issue query inspector for this oubliette.
Return	`osid.hold.IssueQueryInspector`		the issue query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyIssueSequencing
Description	Applies an issue search order to this oubliette.
Parameters	`osid.hold.IssueSearchOrder`	`issueSearchOrder`	the issue search order
Errors	NULL_ARGUMENT		`issueSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`issueSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueQueryFromInspector
Description	Gets an issue query from an inspector.
Parameters	`osid.hold.IssueQueryInspector`	`issueQueryInspector`	an issue query inspector
Return	`osid.hold.IssueQuery`		the issue query
Errors	NULL_ARGUMENT		`issueQueryInspector` is `null`
Errors	UNSUPPORTED		`issueQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.