Interface | osid.calendaring.cycle.CyclicEventCalendarAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
Method | canAssignCyclicEvents | ||
Description |
Tests if this user can alter cyclic 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 | canAssignCyclicEventsToCalendar | ||
Description |
Tests if this user can alter cyclic 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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users. | ||
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 cyclic 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 | getAssignableCalendarIdsForCyclicEvent | ||
Description |
Gets a list of calendars including and under the given calendar node in which a specific cyclic event can be assigned. | ||
Parameters | osid.id.Id | calendarId | the Id of the Calendar |
osid.id.Id | cyclicEventId | the Id of the CyclicEvent | |
Return | osid.id.IdList | list of assignable calendar Ids | |
Errors | NULL_ARGUMENT | calendarId or cyclicEventId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCyclicEventToCalendar | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | cyclicEventId | the Id of the CyclicEvent |
osid.id.Id | calendarId | the Id of the Calendar | |
Errors | ALREADY_EXISTS | cyclicEventId is already assigned to calendarId
| |
NOT_FOUND | cyclicEventId or calendarId not found | ||
NULL_ARGUMENT | cyclicEventId or calendarId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCyclicEventFromCalendar | ||
Description |
Removes a | ||
Parameters | osid.id.Id | cyclicEventId | the Id of the CyclicEvent |
osid.id.Id | calendarId | the Id of the Calendar | |
Errors | NOT_FOUND | cyclicEventId or calendarId not found or
cyclicEventId not assigned to calendarId | |
NULL_ARGUMENT | cyclicEventId or calendarId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignCyclicEventToCalendar | ||
Description |
Moves a | ||
Parameters | osid.id.Id | cyclicEventId | the Id of the CyclicEvent |
osid.id.Id | fromCalendarId | the Id of the current Calendar | |
osid.id.Id | toCalendarId | the Id of the destination Calendar | |
Errors | NOT_FOUND | cyclicEvemtId fromCalendarId, or toCalendarId
not found or cyclicEventId not mapped to fromCalendarId
| |
NULL_ARGUMENT | cyclicEventId, fromCalendarId, or toCalendarId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |