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