public interface AvailabilityEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply AvailabilityEnablers
to Availabilities.
An Availability
with multiple AvailabilityEnablers
means any positive rule
evaluation across the enablers result in an accessible
Availability.
Modifier and Type | Method and Description |
---|---|
void |
assignAvailabilityEnablerToAvailability(Id availabilityEnablerId,
Id availabilityId)
Adds an existing
AvailabilityEnabler to an
Availability. |
boolean |
canAssignAvailabilityEnablers()
Tests if this user can alter availability enabler/availability
mappings.
|
boolean |
canSequenceAvailabilityEnablers()
Tests if this user can order
AvailabilityEnablers. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
moveAvailabilityEnablerAhead(Id availabilityEnablerId,
Id availabilityId,
Id referenceId)
Reorders availability enablers for an availability by moving the
specified availability enabler in front of a reference availability
enabler.
|
void |
moveAvailabilitynEnablerBehind(Id availabilityEnablerId,
Id availabilityId,
Id referenceId)
Reorders availability enablers for an availability by moving the
specified availability enabler behind a reference availability
enabler.
|
void |
orderAvailabilityEnablers(Id[] availabilityEnablerIds,
Id availabilityId)
Reorders a set of availability enablers for an availability.
|
void |
unassignAvailabilityEnablerFromAvailability(Id availabilityEnablerId,
Id availabilityId)
Removes an
AvailabilityEnabler from an
Availability. |
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 canAssignAvailabilityEnablers()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignAvailabilityEnablerToAvailability(Id availabilityEnablerId, Id availabilityId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityEnabler
to an
Availability.
availabilityEnablerId
- the Id
of the
AvailabilityEnabler
availabilityId
- the Id
of the
Availability
AlreadyExistsException
- availabilityEnablerId
is already applied to availabilityId
NotFoundException
- availabilityEnablerId
or availabilityId
not foundNullArgumentException
- availabilityEnablerId
or availabilityId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAvailabilityEnablerFromAvailability(Id availabilityEnablerId, Id availabilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityEnabler
from an
Availability.
availabilityEnablerId
- the Id
of the
AvailabilityEnabler
availabilityId
- the Id
of the
Availability
NotFoundException
- availabilityEnablerId
or availabilityId
not found or
availabilityEnablerId
not applied to
availabilityId
NullArgumentException
- availabilityEnablerId
or availabilityId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceAvailabilityEnablers()
AvailabilityEnablers.
A
return of true does not guarantee successful authorization. A return
of false indicates that it is known sequencing operations will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer sequencing operations to an
unauthorized user. false
if AvailabilityEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveAvailabilityEnablerAhead(Id availabilityEnablerId, Id availabilityId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
availabilityEnablerId
- the Id
of an
AvailabilityEnabler
availabilityId
- the Id
of an Availability
referenceId
- the reference availability enabler Id
NotFoundException
- availabilityEnablerId,
availabilityId,
or referenceId
not
found or, availabilityEnablerId
or
referenceId
not related to availabilityId
NullArgumentException
- availabilityEnablerId,
availabilityId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveAvailabilitynEnablerBehind(Id availabilityEnablerId, Id availabilityId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
availabilityEnablerId
- the Id
of an
AvailabilityEnabler
availabilityId
- the Id
of an Availability
referenceId
- the reference availability enabler Id
NotFoundException
- availabilityEnablerId,
availabilityId,
or referenceId
not
found or, availabilityEnablerId
or
referenceId
not related to availabilityId
NullArgumentException
- availabilityEnablerId,
availabilityId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderAvailabilityEnablers(Id[] availabilityEnablerIds, Id availabilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
availabilityEnablerIds
- the Ids
for a set of
AvailabilityEnablers
availabilityId
- the Id
of an Availability
NotFoundException
- availabilityId
not
found or, an availabilityEnablerId
not related
to availabilityId
NullArgumentException
- availabilityEnablerIds
or availabilityId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.