| Interface | osid.calendaring.rules.RecurringEventEnablerCalendarAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignRecurringEventEnablers | ||
| Description |
Tests if this user can alter recurring event
enabler/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 | canAssignRecurringEventEnablersToCalendar | ||
| Description |
Tests if this user can alter recurring event
enabler/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 enabler 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 | getAssignableCalendarIdsForRecurringEventEnabler | ||
| Description |
Gets a list of calendars including and under the given calendar node in which a specific recurring event enabler can be assigned. | ||
| Parameters | osid.id.Id | calendarId | the Id of the Calendar |
osid.id.Id | recuringEventEnablerId | the Id of the RecurringEventEnabler | |
| Return | osid.id.IdList | list of assignable calendar Ids | |
| Errors | NULL_ARGUMENT | calendarId or recurringEventEnablerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignRecurringEventEnablerToCalendar | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | recurringEventEnablerId | the Id of the RecurringEventEnabler |
osid.id.Id | calendarId | the Id of the Calendar | |
| Errors | ALREADY_EXISTS | recurringEventEnablerId already mapped to calendarId
| |
| NOT_FOUND | recurringEventEnablerId or calendarId not
found | ||
| NULL_ARGUMENT | recurringEventEnablerId or calendarId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignRecurringEventEnablerFromCalendar | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | recurringEventEnablerId | the Id of the RecurringEventEnabler |
osid.id.Id | calendarId | the Id of the Calendar | |
| Errors | NOT_FOUND | recurringEventEnablerId or calendarId not
found or recurringEventEnablerId not assigned to
calendarId | |
| NULL_ARGUMENT | recurringEventEnablerId or calendarId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |