public interface SupersedingEventCalendarAssignmentSession extends OsidSession
This session provides methods to re-assign SupersedingEvents
to Calendars.
A SupersedingEvent
may
map to multiple Calendars
and removing the last reference
to a SupersedingEvent
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 SupersedingEvent
to
another Calendar
is not a copy operation (eg: does not
change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignSupersedingEventToCalendar(Id supersedingEventId,
Id calendarId)
Adds an existing
SupersedingEvent to a Calendar. |
boolean |
canAssignSupersedingEvents()
Tests if this user can alter superseding event/calendar mappings.
|
boolean |
canAssignSupersedingEventsToCalendar(Id calendarId)
Tests if this user can alter superseding event/calendar mappings.
|
IdList |
getAssignableCalendarIds(Id calendarId)
Gets a list of calendars including and under the given calendar node
in which any superseding event can be assigned.
|
IdList |
getAssignableCalendarIdsForSupersedingEvent(Id calendarId,
Id supersedingEventId)
Gets a list of calendars including and under the given calendar node
in which a specific superseding event can be assigned.
|
void |
reassignSupersedingEventToCalendar(Id supersedingEventId,
Id fromBillingId,
Id toBiillingId)
Moves a
SupersedingEvent from one Calendar
to another. |
void |
unassignSupersedingEventFromCalendar(Id supersedingEventId,
Id calendarId)
Removes a
SupersedingEvent from a Calendar. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignSupersedingEvents()
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 canAssignSupersedingEventsToCalendar(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 getAssignableCalendarIdsForSupersedingEvent(Id calendarId, Id supersedingEventId) throws OperationFailedException
calendarId
- the Id
of the Calendar
supersedingEventId
- the Id
of the
supersedingEventId
Ids
NullArgumentException
- calendarId
or
supersedingEventId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignSupersedingEventToCalendar(Id supersedingEventId, Id calendarId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEvent
to a Calendar.
supersedingEventId
- the Id
of the
SupersedingEvent
calendarId
- the Id
of the Calendar
AlreadyExistsException
- supersedingEventId
is already assigned to calendarId
NotFoundException
- supersedingEventId
or calendarId
not foundNullArgumentException
- supersedingEventId
or calendarId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSupersedingEventFromCalendar(Id supersedingEventId, Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEvent
from a Calendar.
supersedingEventId
- the Id
of the
SupersedingEvent
calendarId
- the Id
of the Calendar
NotFoundException
- supersedingEventId
or calendarId
not found or
supersedingEventId
not assigned to calendarId
NullArgumentException
- supersedingEventId
or calendarId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignSupersedingEventToCalendar(Id supersedingEventId, Id fromBillingId, Id toBiillingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEvent
from one Calendar
to another. Mappings to other Calendars
are
unaffected.supersedingEventId
- the Id
of the
SupersedingeEvent
fromBillingId
- the Id
of the current
Calendar
toBiillingId
- the Id
of the destination
Calendar
NotFoundException
- supersedingEventId,
fromCalendarId,
or toCalendarId
not
found or supersedingEventId
not mapped to
fromCalendarId
NullArgumentException
- supersedingEventId,
fromCalendarId,
or toCalendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.