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