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

Interface	osid.hold.rules.HoldEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `HoldEnabler` to `Hold` mappings. A `Hold` with multiple `HoldEnablers` means any positive rule evaluation across the enablers result in an enabled `Hold.` 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 hold enablers defined explicitly in the current oubliette. federated oubliette view: All methods in this session operate, retrieve and pertain to all hold enablers defined in this oubliette and any other oubliette 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	canLookupHoldEnablerRules
Description	Tests if this user can perform lookups of hold enabler/hold 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	useComparativeHoldEnablerRuleView
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	usePlenaryHoldEnablerRuleView
Description	A complete view of the `HoldEnabler` and `Hold` 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 hold 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	getHoldEnablerIdsForHold
Description	Gets the `HoldEnabler Id` associated with a `Hold.`
Parameters	`osid.id.Id`	`holdId`	`Id` of the `Hold`
Return	`osid.id.IdList`		the hold enabler `Ids`
Errors	NOT_FOUND		`holdId` is not found
	NULL_ARGUMENT		`holdId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablersForHold
Description	Gets the `HoldEnabler` associated with a `Hold.`
Parameters	`osid.id.Id`	`holdId`	`Id` of the `Hold`
Return	`osid.hold.rules.HoldEnablerList`		the hold enablers
Errors	NOT_FOUND		`holdId` is not found
	NULL_ARGUMENT		`holdId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldIdsByHoldEnabler
Description	Gets the `Hold` `Ids` mapped to a `HoldEnabler.`
Parameters	`osid.id.Id`	`holdEnablerId`	`Id` of a `HoldEnabler`
Return	`osid.id.IdList`		list of hold `Ids`
Errors	NOT_FOUND		`holdEnablerId` is not found
	NULL_ARGUMENT		`holdEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsByHoldEnabler
Description	Gets the `Holds` mapped to a `HoldEnabler.`
Parameters	`osid.id.Id`	`holdEnablerId`	`Id` of a `HoldEnabler`
Return	`osid.hold.HoldList`		list of holds
Errors	NOT_FOUND		`holdEnablerId` is not found
	NULL_ARGUMENT		`holdEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.