public interface RecurringEventCalendarAssignmentSession extends OsidSession
This session provides methods to re-assign RecurringEvents
to Calendars.
A RecurringEvent
may
map to multiple Calendars
and removing the last reference
to a RecurringEvent
is the equivalent of deleting it. Each
Calendar
may have its own authorizations governing who is
allowed to operate on it.
Moving or adding a reference of a RecurringEvent
to
another Calendar
is not a copy operation (eg: does not
change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignRecurringEventToCalendar(Id recurringEventId,
Id calendarId)
Adds an existing
RecurringEvent to a Calendar. |
boolean |
canAssignRecurringEvents()
Tests if this user can alter recurring event/calendar mappings.
|
boolean |
canAssignRecurringEventsToCalendar(Id calendarId)
Tests if this user can alter recurring event/calendar mappings.
|
IdList |
getAssignableCalendarIds(Id calendarId)
Gets a list of calendars including and under the given calendar node
in which any recurring event can be assigned.
|
IdList |
getAssignableCalendarIdsForRecurringEvent(Id calendarId,
Id recurringEventId)
Gets a list of calendars including and under the given calendar node
in which a specific recurring event can be assigned.
|
void |
reassignRecurringEventToCalendar(Id recurringEventId,
Id fromBillingId,
Id toBiillingId)
Moves a
RecurringEvent from one Calendar
to another. |
void |
unassignRecurringEventFromCalendar(Id recurringEventId,
Id calendarId)
Removes a
RecurringEvent from a Calendar. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignRecurringEvents()
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 canAssignRecurringEventsToCalendar(Id calendarId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer assignment
operations to unauthorized users.calendarId
- the Id
of the Calendar
false
if mapping is not authorized, true
otherwiseNullArgumentException
- calendarId
is
null
mandatory
- This method must be implemented. IdList getAssignableCalendarIds(Id calendarId) throws OperationFailedException
calendarId
- the Id
of the Calendar
Ids
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableCalendarIdsForRecurringEvent(Id calendarId, Id recurringEventId) throws OperationFailedException
calendarId
- the Id
of the Calendar
recurringEventId
- the Id
of the
recurringEventId
Ids
NullArgumentException
- calendarId
or
recurringEventId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignRecurringEventToCalendar(Id recurringEventId, Id calendarId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEvent
to a Calendar.
recurringEventId
- the Id
of the
RecurringEvent
calendarId
- the Id
of the Calendar
AlreadyExistsException
- recurringEventId
is already assigned to calendarId
NotFoundException
- recurringEventId
or
calendarId
not foundNullArgumentException
- recurringEventId
or calendarId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRecurringEventFromCalendar(Id recurringEventId, Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEvent
from a Calendar.
recurringEventId
- the Id
of the
RecurringEvent
calendarId
- the Id
of the Calendar
NotFoundException
- recurringEventId
or
calendarId
not found or recurringEventId
not assigned to calendarId
NullArgumentException
- recurringEventId
or calendarId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignRecurringEventToCalendar(Id recurringEventId, Id fromBillingId, Id toBiillingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEvent
from one Calendar
to another. Mappings to other Calendars
are unaffected.recurringEventId
- the Id
of the
RecurringtEvent
fromBillingId
- the Id
of the current
Calendar
toBiillingId
- the Id
of the destination
Calendar
NotFoundException
- recurringEventId,
fromCalendarId,
or toCalendarId
not
found or recurringEventId
not mapped to
fromCalendarId
NullArgumentException
- recurringEventId,
fromCalendarId,
or toCalendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.