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