| Interface | osid.calendaring.rules.SupersedingEventEnablerCalendarAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignSupersedingEventEnablers | ||
| Description |
Tests if this user can alter superseding 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 | canAssignSupersedingEventEnablersToCalendar | ||
| Description |
Tests if this user can alter superseding 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 superseding 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 | getAssignableCalendarIdsForSupersedingEventEnabler | ||
| Description |
Gets a list of calendars including and under the given calendar node in which a specific superseding event enabler can be assigned. | ||
| Parameters | osid.id.Id | calendarId | the Id of the Calendar |
osid.id.Id | supersedingEventEnablerId | the Id of the SupersedingEventEnabler | |
| Return | osid.id.IdList | list of assignable calendar Ids | |
| Errors | NULL_ARGUMENT | calendarId or supersedingEventEnablerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignSupersedingEventEnablerToCalendar | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | supersedingEventEnablerId | the Id of the SupersedingEventEnabler |
osid.id.Id | calendarId | the Id of the Calendar | |
| Errors | ALREADY_EXISTS | supersedingEventEnablerId already assigned to
calendarId | |
| NOT_FOUND | supersedingEventEnablerId or calendarId not
found | ||
| NULL_ARGUMENT | supersedingEventEnablerId or calendarId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignSupersedingEventEnablerFromCalendar | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | supersedingEventEnablerId | the Id of the SupersedingEventEnabler |
osid.id.Id | calendarId | the Id of the Calendar | |
| Errors | NOT_FOUND | supersedingEventEnablerId or calendarId not
found or supersedingEventEnablerId not assigned to
calendarId | |
| NULL_ARGUMENT | supersedingEventEnablerId or calendarId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignSupersedingEventEnablerToCalendar | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | supersedingEventEnablerId | the Id of the SupersedingEventEnabler |
osid.id.Id | fromCalendarId | the Id of the current Calendar | |
osid.id.Id | toCalendarId | the Id of the destination Calendar | |
| Errors | NOT_FOUND | supersedingEventEnablerId, fromCalendarId,
supersedingEventEnablerId not mapped to fromCalendarId | |
| NULL_ARGUMENT | supersedingEventEnablerId, fromCalendarId, or
toCalendarId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |