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

Interface	osid.hold.rules.HoldEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `HoldEnablers.` 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 hold enabler methods in this session operate, retrieve and pertain to hold enablers defined explicitly in the current oubliette. Using an isolated view is useful for managing `HoldEnablers` with the `HoldEnablerAdminSession.` federated oubliette view: All hold enabler methods in this session operate, retrieve and pertain to all hold enablers defined in this oubliette and any other hold enablers implicitly available in this oubliette through oubliette inheritence. active hold enabler view: All hold enabler lookup methods return active hold enablers. any active hold enabler view: Hold enablers of any active or inactive status are returned from 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	canLookupHoldEnablers
Description	Tests if this user can perform `HoldEnablers` 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	useComparativeHoldEnablerView
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	usePlenaryHoldEnablerView
Description	A complete view of the `HoldEnabler` 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	useActiveHoldEnablerView
Description	Only active hold enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusHoldEnablerView
Description	All active and inactive hold enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getHoldEnabler
Description	Gets the `HoldEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `HoldEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `HoldEnabler` and retained for compatibility. In active mode, hold enablers are returned that are currently active. In any status mode, active and inactive hold enablers are returned.
Parameters	`osid.id.Id`	`holdEnablerId`	`Id` of the `HoldEnabler`
Return	`osid.hold.rules.HoldEnabler`		the hold enabler
Errors	NOT_FOUND		`holdEnablerId` not found
	NULL_ARGUMENT		`holdEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getHoldEnablersByIds
Description	Gets a `HoldEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the hold 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 `HoldEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, hold enablers are returned that are currently active. In any status mode, active and inactive hold enablers are returned.
Parameters	`osid.id.IdList`	`holdEnablerIds`	the list of `Ids` to retrieve
Return	`osid.hold.rules.HoldEnablerList`		the returned `HoldEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`holdEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablersByGenusType
Description	Gets a `HoldEnablerList` corresponding to the given hold enabler genus `Type` which does not include hold enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known hold enablers or an error results. Otherwise, the returned list may contain only those hold enablers that are accessible through this session. In active mode, hold enablers are returned that are currently active. In any status mode, active and inactive hold enablers are returned.
Parameters	`osid.type.Type`	`holdEnablerGenusType`	a hold enabler genus type
Return	`osid.hold.rules.HoldEnablerList`		the returned `HoldEnabler` list
Errors	NULL_ARGUMENT		`holdEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablersByParentGenusType
Description	Gets a `HoldEnablerList` corresponding to the given hold enabler genus `Type` and include any additional hold enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known hold enablers or an error results. Otherwise, the returned list may contain only those hold enablers that are accessible through this session. In active mode, hold enablers are returned that are currently active. In any status mode, active and inactive hold enablers are returned.
Parameters	`osid.type.Type`	`holdEnablerGenusType`	a hold enabler genus type
Return	`osid.hold.rules.HoldEnablerList`		the returned `HoldEnabler` list
Errors	NULL_ARGUMENT		`holdEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablersByRecordType
Description	Gets a `HoldEnablerList` containing the given hold enabler record `Type.` In plenary mode, the returned list contains all known hold enablers or an error results. Otherwise, the returned list may contain only those hold enablers that are accessible through this session. In active mode, hold enablers are returned that are currently active. In any status mode, active and inactive hold enablers are returned.
Parameters	`osid.type.Type`	`holdEnablerRecordType`	a hold enabler record type
Return	`osid.hold.rules.HoldEnablerList`		the returned `HoldEnabler` list
Errors	NULL_ARGUMENT		`holdEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablersOnDate
Description	Gets a `HoldEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known hold enablers or an error results. Otherwise, the returned list may contain only those hold enablers that are accessible through this session. In active mode, hold enablers are returned that are currently active. In any status mode, active and inactive hold enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.hold.rules.HoldEnablerList`		the returned `HoldEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablersOnDateWithAgent
Description	Gets a `HoldEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known hold enablers or an error results. Otherwise, the returned list may contain only those hold enablers that are accessible through this session. In active mode, hold enablers are returned that are currently active. In any status mode, active and inactive hold enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.hold.rules.HoldEnablerList`		the returned `HoldEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablers
Description	Gets all `HoldEnablers.` In plenary mode, the returned list contains all known hold enablers or an error results. Otherwise, the returned list may contain only those hold enablers that are accessible through this session. In active mode, hold enablers are returned that are currently active. In any status mode, active and inactive hold enablers are returned.
Return	`osid.hold.rules.HoldEnablerList`		the returned `HoldEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.