| Interface | osid.calendaring.RecurringEventCalendarAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
| Method | canAssignRecurringEvents | ||
| Description |
Tests if this user can alter recurring 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 | canAssignRecurringEventsToCalendar | ||
| Description |
Tests if this user can alter recurring 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 recurring 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 | getAssignableCalendarIdsForRecurringEvent | ||
| Description |
Gets a list of calendars including and under the given calendar node in which a specific recurring event can be assigned. | ||
| Parameters | osid.id.Id | calendarId | the Id of the Calendar |
osid.id.Id | recurringEventId | the Id of the recurringEventId | |
| Return | osid.id.IdList | list of assignable calendar Ids | |
| Errors | NULL_ARGUMENT | calendarId or recurringEventId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignRecurringEventToCalendar | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | recurringEventId | the Id of the RecurringEvent |
osid.id.Id | calendarId | the Id of the Calendar | |
| Errors | ALREADY_EXISTS | recurringEventId is already assigned to calendarId
| |
| NOT_FOUND | recurringEventId or calendarId not found | ||
| NULL_ARGUMENT | recurringEventId or calendarId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignRecurringEventFromCalendar | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | recurringEventId | the Id of the RecurringEvent |
osid.id.Id | calendarId | the Id of the Calendar | |
| Errors | NOT_FOUND | recurringEventId or calendarId not found or
recurringEventId not assigned to calendarId | |
| NULL_ARGUMENT | recurringEventId or calendarId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignRecurringEventToCalendar | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | recurringEventId | the Id of the RecurringtEvent |
osid.id.Id | fromBillingId | the Id of the current Calendar | |
osid.id.Id | toBiillingId | the Id of the destination Calendar | |
| Errors | NOT_FOUND | recurringEventId, fromCalendarId, or toCalendarId
not found or recurringEventId not mapped to
fromCalendarId | |
| NULL_ARGUMENT | recurringEventId, fromCalendarId, or toCalendarId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |