public interface AvailabilityEnablerRuleLookupSession extends OsidSession
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAvailabilityEnablerRules()
Tests if this user can perform lookups of availability
enabler/availability mappings.
|
AvailabilityList |
getAvailabilitiesForAvailabilityEnabler(Id availabilityEnablerId)
Gets the
Availabilities mapped to an
AvailabilityEnabler. |
IdList |
getAvailabilityEnablerIdsForAvailability(Id availabilityId)
Gets the
AvailabilityEnabler Id associated with an
Availability. |
AvailabilityEnablerList |
getAvailabilityEnablersForAvailability(Id availabilityId)
Gets the
AvailabilityEnabler associated with an
Availability. |
IdList |
getAvailabilityIdsForAvailabilityEnabler(Id availabilityEnablerId)
Gets the
Availability Ids mapped to an
AvailabilityEnabler. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
useComparativeAvailabilityEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
void |
usePlenaryAvailabilityEnablerRuleView()
A complete view of the
AvailabilityEnabler and
Availability returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupAvailabilityEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeAvailabilityEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryAvailabilityEnablerRuleView()
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.mandatory
- This method is must be implemented. void useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. IdList getAvailabilityEnablerIdsForAvailability(Id availabilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityEnabler Id
associated with an
Availability.
availabilityId
- Id
of the Availability
Ids
NotFoundException
- availabilityId
is
not foundNullArgumentException
- availabilityId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityEnablerList getAvailabilityEnablersForAvailability(Id availabilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityEnabler
associated with an
Availability.
availabilityId
- Id
of the Availability
NotFoundException
- availabilityId
is
not foundNullArgumentException
- availabilityId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAvailabilityIdsForAvailabilityEnabler(Id availabilityEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Availability
Ids
mapped to an
AvailabilityEnabler.
availabilityEnablerId
- Id
of an
AvailabilityEnabler
Ids
NotFoundException
- availabilityEnablerId
is not foundNullArgumentException
- availabilityEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesForAvailabilityEnabler(Id availabilityEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Availabilities
mapped to an
AvailabilityEnabler.
availabilityEnablerId
- Id
of an
AvailabilityEnabler
NotFoundException
- availabilityEnablerId
is not foundNullArgumentException
- availabilityEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.