public interface SupersedingEventEnablerCalendarAssignmentSession extends OsidSession
This session provides methods to re-assign
SupersedingEventEnabler
to Calendar
mappings. A
SupersedingEventEnabler
may appear in multiple
Calendar
objects and removing the last reference to a
SupersedingEventEnabler
is the equivalent of deleting it. Each
Calendar
may have its own authorizations governing who is
allowed to operate on it.
Adding a reference of a SupersedingEventEnabler
to
another Calendar
is not a copy operation (eg: does not
change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignSupersedingEventEnablerToCalendar(Id supersedingEventEnablerId,
Id calendarId)
Adds an existing
SupersedingEventEnabler to an
Calendar. |
boolean |
canAssignSupersedingEventEnablers()
Tests if this user can alter superseding event enabler/calendar
mappings.
|
boolean |
canAssignSupersedingEventEnablersToCalendar(Id calendarId)
Tests if this user can alter superseding event enabler/calendar
mappings.
|
IdList |
getAssignableCalendarIds(Id calendarId)
Gets a list of calendars including and under the given calendar node
in which any superseding event enabler can be assigned.
|
IdList |
getAssignableCalendarIdsForSupersedingEventEnabler(Id calendarId,
Id supersedingEventEnablerId)
Gets a list of calendars including and under the given calendar node
in which a specific superseding event enabler can be assigned.
|
void |
reassignSupersedingEventEnablerToCalendar(Id supersedingEventEnablerId,
Id fromCalendarId,
Id toCalendarId)
Moves a
SupersedingEventEnabler from one
Calendar to another. |
void |
unassignSupersedingEventEnablerFromCalendar(Id supersedingEventEnablerId,
Id calendarId)
Removes a
SupersedingEventEnabler from an
Calendar. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignSupersedingEventEnablersToCalendar(Id calendarId)
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup 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 getAssignableCalendarIdsForSupersedingEventEnabler(Id calendarId, Id supersedingEventEnablerId) throws OperationFailedException
calendarId
- the Id
of the Calendar
supersedingEventEnablerId
- the Id
of the
SupersedingEventEnabler
Ids
NullArgumentException
- calendarId
or
supersedingEventEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignSupersedingEventEnablerToCalendar(Id supersedingEventEnablerId, Id calendarId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnabler
to an
Calendar.
supersedingEventEnablerId
- the Id
of the
SupersedingEventEnabler
calendarId
- the Id
of the Calendar
AlreadyExistsException
-
supersedingEventEnablerId
already assigned to
calendarId
NotFoundException
- supersedingEventEnablerId
or calendarId
not foundNullArgumentException
-
supersedingEventEnablerId
or calendarId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSupersedingEventEnablerFromCalendar(Id supersedingEventEnablerId, Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnabler
from an
Calendar.
supersedingEventEnablerId
- the Id
of the
SupersedingEventEnabler
calendarId
- the Id
of the Calendar
NotFoundException
- supersedingEventEnablerId
or calendarId
not found or
supersedingEventEnablerId
not assigned to
calendarId
NullArgumentException
-
supersedingEventEnablerId
or calendarId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignSupersedingEventEnablerToCalendar(Id supersedingEventEnablerId, Id fromCalendarId, Id toCalendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnabler
from one
Calendar
to another. Mappings to other Calendars
are unaffected.supersedingEventEnablerId
- the Id
of the
SupersedingEventEnabler
fromCalendarId
- the Id
of the current
Calendar
toCalendarId
- the Id
of the destination
Calendar
NotFoundException
- supersedingEventEnablerId,
fromCalendarId,
supersedingEventEnablerId
not mapped to fromCalendarId
NullArgumentException
-
supersedingEventEnablerId, fromCalendarId,
or
toCalendarId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.