public interface CalendarHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Calendar
objects. Each node in the hierarchy is a unique
Calendar.
Modifier and Type | Method and Description |
---|---|
void |
addChildCalendar(Id calendarId,
Id childId)
Adds a child to a calendar.
|
void |
addRootCalendar(Id calendarId)
Adds a root calendar.
|
boolean |
canModifyCalendarHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getCalendarHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getCalendarHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildCalendar(Id calendarId,
Id childId)
Removes a child from a calendar.
|
void |
removeChildCalendars(Id calendarId)
Removes all children from a calendar.
|
void |
removeRootCalendar(Id calendarId)
Removes a root calendar from this hierarchy.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getCalendarHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyCalendarHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
calendarId
- the Id
of a calendarNotFoundException
- calendarId
not a
rootNullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
calendarId
- the Id
of a calendarNotFoundException
- calendarId
not a
parent of childId
NullArgumentException
- calendarId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildCalendar(Id calendarId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
calendarId
- the Id
of a calendarchildId
- the Id
of the new childAlreadyExistsException
- calendarId
is
already a parent of childId
NotFoundException
- calendarId
or
childId
not foundNullArgumentException
- calendarId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildCalendar(Id calendarId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
calendarId
- the Id
of a calendarchildId
- the Id
of the new childNotFoundException
- calendarId
not a
parent of childId
NullArgumentException
- calendarId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildCalendars(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
calendarId
- the Id
of a calendarNotFoundException
- calendarId
is in
hierarchyNullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.