OSID Specifications
calendaring package
Version 3.1.0
calendaring package
Version 3.1.0
| Interface | osid.calendaring.CalendarHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.calendaring.CalendaringManager | ||
osid.calendaring.CalendaringProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getCalendarHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCalendarHierarchy | ||
| Description |
Gets the hierarchy associated with this session. | ||
| Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canModifyCalendarHierarchy | ||
| Description |
Tests if this user can change the hierarchy. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known performing any
update will result in a | ||
| Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addRootCalendar | ||
| Description |
Adds a root calendar. | ||
| Parameters | osid.id.Id | calendarId | the Id of a calendar |
| Errors | NOT_FOUND | calendarId not a root | |
| NULL_ARGUMENT | calendarId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootCalendar | ||
| Description |
Removes a root calendar from this hierarchy. | ||
| Parameters | osid.id.Id | calendarId | the Id of a calendar |
| Errors | NOT_FOUND | calendarId not a parent of childId | |
| NULL_ARGUMENT | calendarId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildCalendar | ||
| Description |
Adds a child to a calendar. | ||
| Parameters | osid.id.Id | calendarId | the Id of a calendar |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | calendarId is already a parent of childId | |
| NOT_FOUND | calendarId or childId not found | ||
| NULL_ARGUMENT | calendarId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildCalendar | ||
| Description |
Removes a child from a calendar. | ||
| Parameters | osid.id.Id | calendarId | the Id of a calendar |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | calendarId not a parent of childId | |
| NULL_ARGUMENT | calendarId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildCalendars | ||
| Description |
Removes all children from a calendar. | ||
| Parameters | osid.id.Id | calendarId | the Id of a calendar |
| Errors | NOT_FOUND | calendarId is in hierarchy | |
| NULL_ARGUMENT | calendarId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |