Interface | osid.calendaring.CommitmentCalendarSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines two views:
| ||
Method | canLookupCommitmentCalendarMappings | ||
Description |
Tests if this user can perform lookups of
commitment/calendar mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeCalendarView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryCalendarView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCommitmentIdsByCalendar | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | calendarId | Id of the Calendar |
Return | osid.id.IdList | list of related commitment Ids | |
Errors | NOT_FOUND | calendarId is not found | |
NULL_ARGUMENT | calendarId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentsByCalendar | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | calendarId | Id of the Calendar |
Return | osid.calendaring.CommitmentList | list of related commitments | |
Errors | NOT_FOUND | calendarId is not found | |
NULL_ARGUMENT | calendarId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentIdsByCalendars | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | calendarIds | list of calendar Ids |
Return | osid.id.IdList | list of commitment Ids | |
Errors | NULL_ARGUMENT | calendarIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentsByCalendars | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | calendarIds | list of calendar Ids |
Return | osid.calendaring.CommitmentList | list of commitments | |
Errors | NULL_ARGUMENT | calendarIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarIdsByCommitment | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | commitmentId | Id of a Commitment |
Return | osid.id.IdList | list of calendar Ids | |
Errors | NOT_FOUND | commitmentId is not found | |
NULL_ARGUMENT | commitmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarsByCommitment | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | commitmentId | Id of a Commitment |
Return | osid.calendaring.CalendarList | list of calendar Ids | |
Errors | NOT_FOUND | commitmentId is not found | |
NULL_ARGUMENT | commitmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |