public interface EventCyclicEventAssignmentSession extends OsidSession
This session provides methods to manually assign Events
to CyclicEvents.
An Event
may be the product
of a OsidRule
originating from a SupersedingEvent,
OffsetEvent,
or a RecurringEvent
in
which case the CyclicEvent
is applied to the rule.
Modifier and Type | Method and Description |
---|---|
void |
assignEventToCyclicEvent(Id eventId,
Id cyclicEventId)
Adds an existing
Event to a CyclicEvent. |
boolean |
canAssignCyclicEventsToCyclicEvent(Id cyclicEventId)
Tests if this user can alter event/cyclic event mappings.
|
boolean |
canAssignEvents()
Tests if this user can alter event/cyclic event mappings.
|
IdList |
getAssignableCyclicEventIds()
Gets a list of cyclic event
Ids. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
unassignEventFromCyclicEvent(Id eventId,
Id cyclicEventId)
Removes an
Event from a CyclicEvent. |
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. Calendar
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignEvents()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignCyclicEventsToCyclicEvent(Id cyclicEventId)
cyclicEventId
- the Id
of the CyclicEvent
false
if mapping is not authorized, true
otherwiseNullArgumentException
- cyclicEventId
is
null
mandatory
- This method must be implemented. IdList getAssignableCyclicEventIds() throws OperationFailedException
Ids.
Ids
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignEventToCyclicEvent(Id eventId, Id cyclicEventId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Event
to a CyclicEvent.
eventId
- the Id
of the Event
cyclicEventId
- the Id
of the CyclicEvent
AlreadyExistsException
- eventId
is
already assigned to cyclicEventId
NotFoundException
- eventId
or
cyclicEventId
not foundNullArgumentException
- eventId
or
cyclicEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignEventFromCyclicEvent(Id eventId, Id cyclicEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Event
from a CyclicEvent.
eventId
- the Id
of the Event
cyclicEventId
- the Id
of the CyclicEvent
NotFoundException
- eventId
or
cyclicEventId
not found or eventId
is
not assigned to cyclicEventId
NullArgumentException
- eventId
or
cyclicEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.