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

Interface	osid.hold.rules.IssueProcessorQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.hold.rules.IssueProcessorSearchSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods for searching among `IssueProcessor` objects. The search query is constructed using the `IssueProcessorQuery` . This session defines views that offer differing behaviors for searching. federated oubliette view: searches include issue processors in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy isolated oubliette view: searches are restricted to issue processors in this oubliette Issue processors may have a query record indicated by their respective record types. The query record is accessed via the `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.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchIssueProcessors
Description	Tests if this user can perform `IssueProcessor` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedOublietteView
Description	Federates the view for methods in this session. A federated view will include issue processors in oubliettes which are children of this oubliette in the oubliette hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOublietteView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this oubliette only.
Compliance	`mandatory`		This method is 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	getIssueProcessorsByQuery
Description	Gets a list of `IssueProcessors` matching the given search.
Parameters	`osid.hold.rules.IssueProcessorQuery`	`issueProcessorQuery`	the issue processor query
Return	`osid.hold.rules.IssueProcessorList`		the returned `IssueProcessorList`
Errors	NULL_ARGUMENT		`issueProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueProcessorQuery` did not originate from `getIssueProcessorQuery()`
Compliance	`mandatory`		This method must be implemented.