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

Interface	osid.resourcing.rules.AvailabilityEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `AvailabilityEnabler` to `Availability` mappings. An `Availability` with multiple `AvailabilityEnablers` means any positive rule evaluation across the enablers result in an accessible `Availability.` 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 foundry view: All methods in this session operate, retrieve and pertain to availability enablers defined explicitly in the current foundry federated foundry view: All 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.
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	canLookupAvailabilityEnablerRules
Description	Tests if this user can perform lookups of availability enabler/availability 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	useComparativeAvailabilityEnablerRuleView
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	usePlenaryAvailabilityEnablerRuleView
Description	A complete view of the `AvailabilityEnabler` and `Availability` 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	getAvailabilityEnablerIdsForAvailability
Description	Gets the `AvailabilityEnabler Id` associated with an `Availability.`
Parameters	`osid.id.Id`	`availabilityId`	`Id` of the `Availability`
Return	`osid.id.IdList`		the availability enabler `Ids`
Errors	NOT_FOUND		`availabilityId` is not found
	NULL_ARGUMENT		`availabilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablersForAvailability
Description	Gets the `AvailabilityEnabler` associated with an `Availability.`
Parameters	`osid.id.Id`	`availabilityId`	`Id` of the `Availability`
Return	`osid.resourcing.rules.AvailabilityEnablerList`		the availability enablers
Errors	NOT_FOUND		`availabilityId` is not found
	NULL_ARGUMENT		`availabilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityIdsForAvailabilityEnabler
Description	Gets the `Availability` `Ids` mapped to an `AvailabilityEnabler.`
Parameters	`osid.id.Id`	`availabilityEnablerId`	`Id` of an `AvailabilityEnabler`
Return	`osid.id.IdList`		list of availability `Ids`
Errors	NOT_FOUND		`availabilityEnablerId` is not found
	NULL_ARGUMENT		`availabilityEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesForAvailabilityEnabler
Description	Gets the `Availabilities` mapped to an `AvailabilityEnabler.`
Parameters	`osid.id.Id`	`availabilityEnablerId`	`Id` of an `AvailabilityEnabler`
Return	`osid.resourcing.AvailabilityList`		list of availabilities
Errors	NOT_FOUND		`availabilityEnablerId` is not found
	NULL_ARGUMENT		`availabilityEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.