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

Interface	osid.hold.rules.IssueProcessorEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods to retrieve `IssueProcessorEnabler` to `IssueProcessor mappings` . This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated oubliette view: All methods in this session operate, retrieve and pertain to issue processor enablers defined explicitly in the current oubliette federated oubliette view: All methods in this session operate, retrieve and pertain to all issue processor enablers defined in this oubliette and any other issue processor enablers implicitly available in this oubliette through oubliette inheritence.
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	canLookupIssueProcessorEnablerRules
Description	Tests if this user can perform lookups of issue processor enabler/issue processor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeIssueProcessorEnablerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryIssueProcessorEnablerRuleView
Description	A complete view of the `IssueProcessorEnabler` and `IssueProcessor` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedOublietteView
Description	Federates the view for methods in this session. A federated view will include issue processor enablers 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 lookups to this oubliette only.
Compliance	`mandatory`		This method is must be implemented.
Method	getIssueProcessorEnablerIdsForIssue
Description	Gets the `IssueProcessorEnabler Ids` associated with an `IssueProcessor` .
Parameters	`osid.id.Id`	`issueProcessorId`	`Id` of the `IssueProcessor`
Return	`osid.id.IdList`		the issue processor enabler `Ids`
Errors	NOT_FOUND		`issueProcessorId` is not found
	NULL_ARGUMENT		`issueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorEnablersForIssueProcessor
Description	Gets the `IssueProcessorEnablers` associated with an `IssueProcessor` .
Parameters	`osid.id.Id`	`issueProcessorId`	`Id` of the `IssueProcessor`
Return	`osid.hold.rules.IssueProcessorEnablerList`		the issue processor enablers
Errors	NOT_FOUND		`issueProcessorId` is not found
	NULL_ARGUMENT		`issueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorIdsForIssueProcessorEnabler
Description	Gets the `IssueProcessor` `Ids` mapped to an `IssueProcessorEnabler` .
Parameters	`osid.id.Id`	`issueProcessorEnablerId`	`Id` of an `IssueProcessorEnabler`
Return	`osid.id.IdList`		list of issue `Ids`
Errors	NOT_FOUND		`issueProcessorEnablerId` is not found
	NULL_ARGUMENT		`issueProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorsForIssueProcessorEnabler
Description	Gets the `IssueProcessors` mapped to an `IssueProcessorEnabler` .
Parameters	`osid.id.Id`	`issueProcessorEnablerId`	`Id` of an `IssueprocessorEnabler`
Return	`osid.hold.rules.IssueProcessorList`		list of issue processors
Errors	NOT_FOUND		`issueProcessorEnablerId` is not found
	NULL_ARGUMENT		`issueProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.