| Interface | osid.calendaring.SupersedingEventCalendarAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
| Method | canAssignSupersedingEvents | ||
| Description |
Tests if this user can alter superseding event/calendar
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignSupersedingEventsToCalendar | ||
| Description |
Tests if this user can alter superseding event/calendar
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Parameters | osid.id.Id | calendarId | the Id of the Calendar |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | calendarId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCalendarIds | ||
| Description |
Gets a list of calendars including and under the given calendar node in which any superseding event can be assigned. | ||
| Parameters | osid.id.Id | calendarId | the Id of the Calendar |
| Return | osid.id.IdList | list of assignable calendar Ids | |
| Errors | NULL_ARGUMENT | calendarId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCalendarIdsForSupersedingEvent | ||
| Description |
Gets a list of calendars including and under the given calendar node in which a specific superseding event can be assigned. | ||
| Parameters | osid.id.Id | calendarId | the Id of the Calendar |
osid.id.Id | supersedingEventId | the Id of the supersedingEventId | |
| Return | osid.id.IdList | list of assignable calendar Ids | |
| Errors | NULL_ARGUMENT | calendarId or supersedingEventId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignSupersedingEventToCalendar | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | supersedingEventId | the Id of the SupersedingEvent |
osid.id.Id | calendarId | the Id of the Calendar | |
| Errors | ALREADY_EXISTS | supersedingEventId is already assigned to calendarId
| |
| NOT_FOUND | supersedingEventId or calendarId not found | ||
| NULL_ARGUMENT | supersedingEventId or calendarId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignSupersedingEventFromCalendar | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | supersedingEventId | the Id of the SupersedingEvent |
osid.id.Id | calendarId | the Id of the Calendar | |
| Errors | NOT_FOUND | supersedingEventId or calendarId not found or
supersedingEventId not assigned to calendarId | |
| NULL_ARGUMENT | supersedingEventId or calendarId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignSupersedingEventToCalendar | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | supersedingEventId | the Id of the SupersedingeEvent |
osid.id.Id | fromBillingId | the Id of the current Calendar | |
osid.id.Id | toBiillingId | the Id of the destination Calendar | |
| Errors | NOT_FOUND | supersedingEventId, fromCalendarId, or toCalendarId
not found or supersedingEventId not mapped to
fromCalendarId | |
| NULL_ARGUMENT | supersedingEventId, fromCalendarId, or toCalendarId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |