OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.CommitmentCalendarSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Commitment to Calendar mappings. A Commitment may appear in multiple Calendars. Each Calendar may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupCommitmentCalendarMappings
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCalendarView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCalendarView
Description

A complete view of the Commitment and Calendar returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetCommitmentIdsByCalendar
Description

Gets the list of Commitment Ids associated with an Calendar.

Parametersosid.id.IdcalendarId Id of the Calendar
Returnosid.id.IdListlist of related commitment Ids
ErrorsNOT_FOUND calendarId is not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentsByCalendar
Description

Gets the list of Commitments associated with an Calendar.

Parametersosid.id.IdcalendarId Id of the Calendar
Returnosid.calendaring.CommitmentListlist of related commitments
ErrorsNOT_FOUND calendarId is not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentIdsByCalendars
Description

Gets the list of Commitment Ids corresponding to a list of Calendars.

Parametersosid.id.IdListcalendarIdslist of calendar Ids
Returnosid.id.IdListlist of commitment Ids
ErrorsNULL_ARGUMENT calendarIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentsByCalendars
Description

Gets the list of Commitments corresponding to a list of Calendars.

Parametersosid.id.IdListcalendarIdslist of calendar Ids
Returnosid.calendaring.CommitmentListlist of commitments
ErrorsNULL_ARGUMENT calendarIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCalendarIdsByCommitment
Description

Gets the list of Calendar Ids mapped to a Commitment.

Parametersosid.id.IdcommitmentId Id of a Commitment
Returnosid.id.IdListlist of calendar Ids
ErrorsNOT_FOUND commitmentId is not found
NULL_ARGUMENT commitmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCalendarsByCommitment
Description

Gets the list of Calendars mapped to a Commitment.

Parametersosid.id.IdcommitmentId Id of a Commitment
Returnosid.calendaring.CalendarListlist of calendar Ids
ErrorsNOT_FOUND commitmentId is not found
NULL_ARGUMENT commitmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.