public interface RecurringEventEnablerCalendarAssignmentSession extends OsidSession
This session provides methods to re-assign RecurringEventEnabler
to Calendar
mappings. A
RecurringEventEnabler
may appear in multiple Calendar
objects and removing the last reference to a
RecurringEventEnabler
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 RecurringEventEnabler
to
another Calendar
is not a copy operation (eg: does not
change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignRecurringEventEnablerToCalendar(Id recurringEventEnablerId,
Id calendarId)
Adds an existing
RecurringEventEnabler to an
Calendar. |
boolean |
canAssignRecurringEventEnablers()
Tests if this user can alter recurring event enabler/calendar
mappings.
|
boolean |
canAssignRecurringEventEnablersToCalendar(Id calendarId)
Tests if this user can alter recurring event enabler/calendar
mappings.
|
IdList |
getAssignableCalendarIds(Id calendarId)
Gets a list of calendars including and under the given calendar node
in which any recurring event enabler can be assigned.
|
IdList |
getAssignableCalendarIdsForRecurringEventEnabler(Id calendarId,
Id recuringEventEnablerId)
Gets a list of calendars including and under the given calendar node
in which a specific recurring event enabler can be assigned.
|
void |
unassignRecurringEventEnablerFromCalendar(Id recurringEventEnablerId,
Id calendarId)
Removes a
RecurringEventEnabler from an
Calendar. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignRecurringEventEnablers()
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 canAssignRecurringEventEnablersToCalendar(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 getAssignableCalendarIdsForRecurringEventEnabler(Id calendarId, Id recuringEventEnablerId) throws OperationFailedException
calendarId
- the Id
of the Calendar
recuringEventEnablerId
- the Id
of the
RecurringEventEnabler
Ids
NullArgumentException
- calendarId
or
recurringEventEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignRecurringEventEnablerToCalendar(Id recurringEventEnablerId, Id calendarId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEventEnabler
to an
Calendar.
recurringEventEnablerId
- the Id
of the
RecurringEventEnabler
calendarId
- the Id
of the Calendar
AlreadyExistsException
- recurringEventEnablerId
already mapped to calendarId
NotFoundException
- recurringEventEnablerId
or calendarId
not foundNullArgumentException
- recurringEventEnablerId
or calendarId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRecurringEventEnablerFromCalendar(Id recurringEventEnablerId, Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEventEnabler
from an
Calendar.
recurringEventEnablerId
- the Id
of the
RecurringEventEnabler
calendarId
- the Id
of the Calendar
NotFoundException
- recurringEventEnablerId
or calendarId
not found or
recurringEventEnablerId
not assigned to
calendarId
NullArgumentException
- recurringEventEnablerId
or calendarId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.