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