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

Interface	osid.hold.rules.IssueEnablerLookupSession
Implements	`osid.OsidSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods for retrieving `IssueEnablers` . This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated oubliette view: All issue enabler methods in this session operate, retrieve and pertain to issue enablers defined explicitly in the current oubliette Using an isolated view is useful for managing `IssueEnablers` with the `IssueEnablerAdminSession` . federated issue enabler view: All issue enabler methods in this session operate, retrieve and pertain to all issue enablers defined in this oubliette and any other issue enablers implicitly available in this oubliette through oubliette inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedOublietteView()` and `useIsolatedOublietteView() beha` ve as a radio group and one should be selected before invoking any lookup methods.
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	canLookupIssueEnablers
Description	Tests if this user can perform `IssueEnabler` lookups. 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 opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeIssueEnablerView
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	usePlenaryIssueEnablerView
Description	A complete view of the `IssueEnabler` 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 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	getIssueEnabler
Description	Gets the `IssueEnabler` specified by its `Id` . In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `IssueEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `IssueEnabler a` nd retained for compatibility.
Parameters	`osid.id.Id`	`issueEnablerId`	`Id` of the `IssueEnabler`
Return	`osid.hold.rules.IssueEnabler`		the issue enabler
Errors	NOT_FOUND		`issueEnablerId` not found
	NULL_ARGUMENT		`issueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getIssueEnablersByIds
Description	Gets an `IssueEnablerList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the issue enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `IssueEnablers may` be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`issueEnablerIds`	the list of `Ids` to retrieve
Return	`osid.hold.rules.IssueEnablerList`		the returned `IssueEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`issueEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablersByGenusType
Description	Gets an `IssueEnablerList` corresponding to the given issue enabler genus `Type` which does not include issue enablers of genus types derived from the specified `Type` . In plenary mode, the returned list contains all known issue enablers or an error results. Otherwise, the returned list may contain only those issue enablers that are accessible through this session.
Parameters	`osid.type.Type`	`issueEnablerGenusType`	an issue enabler genus type
Return	`osid.hold.rules.IssueEnablerList`		the returned `IssueEnabler` list
Errors	NULL_ARGUMENT		`issueEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablersByParentGenusType
Description	Gets an `IssueEnablerList` corresponding to the given issue enabler genus `Type` and include any additional issue enablers with genus types derived from the specified `Type` . In plenary mode, the returned list contains all known issue enablers or an error results. Otherwise, the returned list may contain only those issue enablers that are accessible through this session.
Parameters	`osid.type.Type`	`issueEnablerGenusType`	an issue enabler genus type
Return	`osid.hold.rules.IssueEnablerList`		the returned `IssueEnabler` list
Errors	NULL_ARGUMENT		`issueEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablersByRecordType
Description	Gets an `IssueEnablerList` containing the given issue enabler record `Type` . In plenary mode, the returned list contains all known issue enablers or an error results. Otherwise, the returned list may contain only those issue enablers that are accessible through this session.
Parameters	`osid.type.Type`	`issueEnablerRecordType`	an issue enabler record type
Return	`osid.hold.rules.IssueEnablerList`		the returned `IssueEnabler` list
Errors	NULL_ARGUMENT		`issueEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablers
Description	Gets all `IssueEnablers` . In plenary mode, the returned list contains all known issue enablers or an error results. Otherwise, the returned list may contain only those issue enablers that are accessible through this session.
Return	`osid.hold.rules.IssueEnablerList`		a list of `IssueEnablers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.