public interface RecurringEventEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply RecurringEventEnablers
to RecurringEvents.
A RecurringEvent
with multiple RecurringEventEnablers
means any positive
rule evaluation across the enablers result in an effective
RecurringEvent.
Modifier and Type | Method and Description |
---|---|
void |
assignRecurringEventEnablerToRecurringEvent(Id recurringEventEnablerId,
Id recurringEventId)
Adds an existing
RecurringEventEnabler to a
RecurringEvent. |
boolean |
canAssignRecurringEventEnablerRules()
Tests if this user can alter recurring event enabler/recurring event
mappings.
|
boolean |
canSequenceRecurringEventEnablers()
Tests if this user can order
RecurringEventEnablers. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
moveRecurringEventEnablerAhead(Id recurringEventEnablerId,
Id recurringEventId,
Id referenceId)
Reorders recurring event enablers for a recurring event by moving the
specified recurring event enabler in front of a reference recurring
event enabler.
|
void |
moveRecurringEventEnablerBehind(Id recurringEventEnablerId,
Id recurringEventId,
Id referenceId)
Reorders recurring event enablers for a recurring event by moving the
specified recurring event enabler behind a reference recurring event
enabler.
|
void |
orderRecurringEventEnablers(Id[] recurringEventEnablerIds,
Id recurringEventId)
Reorders a set of recurring event enablers for a recurring event.
|
void |
unassignRecurringEventEnablerFromRecurringEvent(Id recurringEventEnablerId,
Id recurringEventId)
Removes a
RecurringEventEnabler from a
RecurringEvent. |
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 canAssignRecurringEventEnablerRules()
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 assignRecurringEventEnablerToRecurringEvent(Id recurringEventEnablerId, Id recurringEventId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEventEnabler
to a
RecurringEvent.
recurringEventEnablerId
- the Id
of the
RecurringEventEnabler
recurringEventId
- the Id
of the
RecurringEvent
AlreadyExistsException
- recurringEventEnablerId
already applied to recurringEventId
NotFoundException
- recurringEventEnablerId
or recurringEventId
not foundNullArgumentException
- recurringEventEnablerId
or recurringEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRecurringEventEnablerFromRecurringEvent(Id recurringEventEnablerId, Id recurringEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEventEnabler
from a
RecurringEvent.
recurringEventEnablerId
- the Id
of the
RecurringEventEnabler
recurringEventId
- the Id
of the
RecurringEvent
NotFoundException
- recurringEventEnablerId
or recurringEventId
not found or
recurringEventEnablerId
not applied to
recurringEventId
NullArgumentException
- recurringEventEnablerId
or recurringEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceRecurringEventEnablers()
RecurringEventEnablers.
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 RecurringEventEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveRecurringEventEnablerAhead(Id recurringEventEnablerId, Id recurringEventId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
recurringEventEnablerId
- the Id
of a
RecurringEventEnabler
recurringEventId
- the Id
of a
RecurringEvent
referenceId
- the reference recurring event enabler Id
NotFoundException
- recurringEventEnablerId,
recurringEventId,
or referenceId
not
found or, recurringEventEnablerId
or
referenceId
not related to recurringEventId
NullArgumentException
- recurringEventEnablerId,
recurringEventId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveRecurringEventEnablerBehind(Id recurringEventEnablerId, Id recurringEventId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
recurringEventEnablerId
- the Id
of a
RecurringEventEnabler
recurringEventId
- the Id
of a
RecurringEvent
referenceId
- the reference recurring event enabler Id
NotFoundException
- recurringEventEnablerId,
recurringEventId,
or referenceId
not
found or, recurringEventEnablerId
or
referenceId
not related to recurringEventId
NullArgumentException
- recurringEventEnablerId,
recurringEventId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderRecurringEventEnablers(Id[] recurringEventEnablerIds, Id recurringEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
recurringEventEnablerIds
- the Ids
for a set of
RecurringEventEnablers
recurringEventId
- the Id
of a
RecurringEvent
NotFoundException
- recurringEventEnablerId
not related to recurringEventId
NullArgumentException
- rceurringEventEnablerIds
or recurringEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.