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