OSID - osid.resourcing.rules.AvailabilityEnablerLookupSession Service Interface Definition

Interface	osid.resourcing.rules.AvailabilityEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `AvailabilityEnablers.` 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 foundry view: All availability enabler methods in this session operate, retrieve and pertain to availability enablers defined explicitly in the current foundry. Using an isolated view is useful for managing `AvailabilityEnablers` with the `AvailabilityEnablerAdminSession.` federated foundry view: All availability enabler methods in this session operate, retrieve and pertain to all availability enablers defined in this foundry and any other availability enabler implicitly available in this foundry through foundry inheritence. active availability enabler view: All availability enabler lookup methods return active availability enablers. any status availability enabler view: Availability enablers of any active or inactive status are returned from methods. 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 `useFederatedFoundryView()` and `useIsolatedFoundryView()` behave as a radio group and one should be selected before invoking the methods in this session.
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupAvailabilityEnablers
Description	Tests if this user can perform `AvailabilityEnablers` 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	useComparativeAvailabilityEnablerView
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	usePlenaryAvailabilityEnablerView
Description	A complete view of the `AvailabilityEnabler` 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	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include availability enabler in foundries which are children of this foundry in the foundry hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFoundryView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveAvailabilityEnablerView
Description	Only active availability enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusAvailabilityEnablerView
Description	All active and inactive availability enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getAvailabilityEnabler
Description	Gets the `AvailabilityEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `AvailabilityEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `AvailabilityEnabler` and retained for compatibility. In active mode, availability enablers are returned that are currently active. In any status mode, active and inactive availability enablers are returned.
Parameters	`osid.id.Id`	`availabilityEnablerId`	`Id` of the `AvailabilityEnabler`
Return	`osid.resourcing.rules.AvailabilityEnabler`		the availability enabler
Errors	NOT_FOUND		`availabilityEnablerrId` not found
	NULL_ARGUMENT		`availabilityEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAvailabilityEnablersByIds
Description	Gets a `AvailabilityEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the availability enabler specified in the `Id` list, in the order of the list, including duplicates, or an error results if a `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `AvailabilityEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, availability enablers are returned that are currently active. In any status mode, active and inactive availability enablers are returned.
Parameters	`osid.id.IdList`	`availabilityEnablerIds`	the list of `Ids` to retrieve
Return	`osid.resourcing.rules.AvailabilityEnablerList`		the returned `AvailabilityEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`availabilityEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablersByGenusType
Description	Gets an `AvailabilityEnablerList` corresponding to the given availability enabler genus `Type` which does not include availability enabler of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known availability enabler or an error results. Otherwise, the returned list may contain only those availability enabler that are accessible through this session. In active mode, availability enablers are returned that are currently active. In any status mode, active and inactive availability enablers are returned.
Parameters	`osid.type.Type`	`availabilityEnablerGenusType`	an availability enabler genus type
Return	`osid.resourcing.rules.AvailabilityEnablerList`		the returned `AvailabilityEnabler` list
Errors	NULL_ARGUMENT		`availabilityEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablersByParentGenusType
Description	Gets an `AvailabilityEnablerList` corresponding to the given availability enabler genus `Type` and include any additional availability enabler with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known availability enabler or an error results. Otherwise, the returned list may contain only those availability enabler that are accessible through this session. In active mode, availability enablers are returned that are currently active. In any status mode, active and inactive availability enablers are returned.
Parameters	`osid.type.Type`	`availabilityEnablerGenusType`	an availability enabler genus type
Return	`osid.resourcing.rules.AvailabilityEnablerList`		the returned `AvailabilityEnabler` list
Errors	NULL_ARGUMENT		`availabilityEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablersByRecordType
Description	Gets an `AvailabilityEnablerList` containing the given availability enabler record `Type.` In plenary mode, the returned list contains all known availability enabler or an error results. Otherwise, the returned list may contain only those availability enabler that are accessible through this session. In active mode, availability enablers are returned that are currently active. In any status mode, active and inactive availability enablers are returned.
Parameters	`osid.type.Type`	`availabilityEnablerRecordType`	an availability enabler record type
Return	`osid.resourcing.rules.AvailabilityEnablerList`		the returned `AvailabilityEnabler` list
Errors	NULL_ARGUMENT		`availabilityEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablersOnDate
Description	Gets an `AvailabilityEnablerList` 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 availability enablers or an error results. Otherwise, the returned list may contain only those availability enablers that are accessible through this session. In active mode, availability enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive availability enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.resourcing.rules.AvailabilityEnablerList`		the returned `AvailabilityEnabler` 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	getAvailabilityEnablersOnDateWithAgent
Description	Gets an `AvailabilityEnablerList` that are effective for the entire given date range and evaluated against the given agent. In plenary mode, the returned list contains all known availability enablers or an error results. Otherwise, the returned list may contain only those availability enablers that are accessible through this session. In active mode, availability enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive availability 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.resourcing.rules.AvailabilityEnablerList`		the returned `AvailabilityEnabler` 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	getAvailabilityEnablers
Description	Gets all `AvailabilityEnablers.` In plenary mode, the returned list contains all known availability enabler or an error results. Otherwise, the returned list may contain only those availability enabler that are accessible through this session. In active mode, availability enablers are returned that are currently active. In any status mode, active and inactive availability enablers are returned.
Return	`osid.resourcing.rules.AvailabilityEnablerList`		the returned `AvailabilityEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.