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