public interface SupersedingEventEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply SupersedingEventEnablers
to SupersedingEvents.
A SupersedingEvent
with multiple SupersedingEventEnablers
means any
positive rule evaluation across the enablers result in an effective
SupersedingEvent.
Modifier and Type | Method and Description |
---|---|
void |
assignSupersedingEventEnablerToSupersedingEvent(Id supersedingEventEnablerId,
Id supersedingEventId)
Adds an existing
SupersedingEventEnabler to a
SupersedingEvent. |
boolean |
canAssignSupersedingEventEnablers()
Tests if this user can alter superseding event enabler/superseding
event mappings.
|
boolean |
canSequenceSupersedingEventEnablers()
Tests if this user can order
SupersedingEventEnablers. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
moveSupersedingEventEnablerAhead(Id supersedingEventEnablerId,
Id supersedingEventId,
Id referenceId)
Reorders superseding event enablers for a superseding event by moving
the specified superseding event enabler in front of a reference
superseding event enabler.
|
void |
moveSupersedingEventEnablerBehind(Id supersedingEventEnablerId,
Id supersedingEventId,
Id referenceId)
Reorders superseding event enablers for a superseding event by moving
the specified superseding event enabler behind a reference superseding
event enabler.
|
void |
orderSupersedingEventEnablers(Id[] supersedingEventEnablerIds,
Id supersedingEventId)
Reorders a set of superseding event enablers for a superseding event.
|
void |
unassignSupersedingEventEnablerFromSupersedingEvent(Id supersedingEventEnablerId,
Id supersedingEventId)
Removes a
SupersedingEventEnabler from a
SupersedingEvent. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignSupersedingEventEnablers()
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 assignSupersedingEventEnablerToSupersedingEvent(Id supersedingEventEnablerId, Id supersedingEventId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnabler
to a
SupersedingEvent.
supersedingEventEnablerId
- the Id
of the
SupersedingEventEnabler
supersedingEventId
- the Id
of the
SupersedingEvent
AlreadyExistsException
-
supersedingEventEnablerId
already applied to
supersedingEventId
NotFoundException
- supersedingEventEnablerId
or supersedingEventId
not foundNullArgumentException
-
supersedingEventEnablerId
or supersedingEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSupersedingEventEnablerFromSupersedingEvent(Id supersedingEventEnablerId, Id supersedingEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnabler
from a
SupersedingEvent.
supersedingEventEnablerId
- the Id
of the
SupersedingEventEnabler
supersedingEventId
- the Id
of the
Calendar
NotFoundException
- supersedingEventEnablerId
or supersedingEventId
not found or
supersedingEventEnablerId
not applied to
supersedingEventId
NullArgumentException
-
supersedingEventEnablerId
or supersedingEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceSupersedingEventEnablers()
SupersedingEventEnablers.
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 SupersedingEventEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveSupersedingEventEnablerAhead(Id supersedingEventEnablerId, Id supersedingEventId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
supersedingEventEnablerId
- the Id
of a
SupersedingEventEnabler
supersedingEventId
- the Id
of a
SupersedingEvent
referenceId
- the reference superseding event enabler Id
NotFoundException
- supersedingEventEnablerId,
supersedingEventId,
or referenceId
not
found or, supersedingEventEnablerId
or
referenceId
not related to supersedingEventId
NullArgumentException
-
supersedingEventEnablerId, supersedingEventId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveSupersedingEventEnablerBehind(Id supersedingEventEnablerId, Id supersedingEventId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
supersedingEventEnablerId
- the Id
of a
SupersedingEventEnabler
supersedingEventId
- the Id
of a
SupersedingEvent
referenceId
- the reference superseding event enabler Id
NotFoundException
- supersedingEventEnablerId,
supersedingEventId,
or referenceId
not
found or, supersedingEventEnablerId
or
referenceId
not related to supersedingEventId
NullArgumentException
-
supersedingEventEnablerId, supersedingEventId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderSupersedingEventEnablers(Id[] supersedingEventEnablerIds, Id supersedingEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
supersedingEventEnablerIds
- the Ids
for a set of
SupersedingEventEnablerIds
supersedingEventId
- the Id
of a
SupersedingEvent
NotFoundException
- supersedingEventId
not found or, an supersedingEventEnablerId
not
related to supersedingEventId
NullArgumentException
-
supersedingEventEnablerIds
or
supersedingEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.