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

This session provides methods to re-assign Commitments to Calendars. A Commitment may map to multiple Calendars and removing the last reference to a Commitment is the equivalent of deleting it. Each Calendar may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of a Commitment to another Calendar is not a copy operation (eg: does not change its Id ).

MethodcanAssignCommitments
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 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignCommitmentsToCalendar
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parametersosid.id.IdcalendarIdthe Id of the Calendar
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT calendarId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCalendarIds
Description

Gets a list of calendars including and under the given calendar node in which any commitment can be assigned.

Parametersosid.id.IdcalendarIdthe Id of the Calendar
Returnosid.id.IdListlist of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCalendarIdsForCommitment
Description

Gets a list of calendars including and under the given calendar node in which a specific commitment can be assigned.

Parametersosid.id.IdcalendarIdthe Id of the Calendar
osid.id.IdcommitmentIdthe Id of the Commitment
Returnosid.id.IdListlist of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId or commitmentId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignCommitmentToCalendar
Description

Adds an existing Commitment to a Calendar.

Parametersosid.id.IdcommitmentIdthe Id of the Commitment
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsALREADY_EXISTS commitmentId is already assigned to calendarId
NOT_FOUND commitmentId or calendarId not found
NULL_ARGUMENT commitmentId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignCommitmentFromCalendar
Description

Removes a Commitment from a Calendar.

Parametersosid.id.IdcommitmentIdthe Id of the Commitment
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsNOT_FOUND commitmentId or calendarId not found or commitmentId not assigned to calendarId
NULL_ARGUMENT commitmentId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignCommitmentToCalendar
Description

Moves a Commitment from one Calendar to another. Mappings to other Calendars are unaffected.

Parametersosid.id.IdcommitmentIdthe Id of the Commitment
osid.id.IdfromBillingIdthe Id of the current Calendar
osid.id.IdtoBiillingIdthe Id of the destination Calendar
ErrorsNOT_FOUND commitmentId, fromCalendarId, or toCalendarId not found or commitmentId not mapped to fromCalendarId
NULL_ARGUMENT commitmentId, fromCalendarId, or toCalendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.