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

This session provides methods to re-assign CommitmentEnabler to Calendar mappings. A CommitmentEnabler may appear in multiple Calendar objects and removing the last reference to a CommitmentEnabler is the equivalent of deleting it. Each Calendar may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a CommitmentEnabler to another Calendar is not a copy operation (eg: does not change its Id ).

MethodcanAssignCommitmentEnablers
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 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.
MethodcanAssignCommitmentEnablersToCalendar
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 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 enabler 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.
MethodgetAssignableCalendarIdsForCommitmentEnabler
Description

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

Parametersosid.id.IdcalendarIdthe Id of the Calendar
osid.id.IdcommitmentEnablerIdthe Id of the CommitmentEnabler
Returnosid.id.IdListlist of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId or commitmentEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignCommitmentEnablerToCalendar
Description

Adds an existing CommitmentEnabler to an Calendar.

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

Removes a CommitmentEnabler from an Calendar.

Parametersosid.id.IdcommitmentEnablerIdthe Id of the CommitmentEnabler
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsNOT_FOUND commitmentEnablerId or calendarId not found or commitmentEnablerId not assigned to calendarId
NULL_ARGUMENT commitmentEnablerId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignCommitmentEnablerToCalendar
Description

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

Parametersosid.id.IdcommitmentEnablerIdthe Id of the CommitmentEnabler
osid.id.IdfromCalendarIdthe Id of the current Calendar
osid.id.IdtoCalendarIdthe Id of the destination Calendar
ErrorsNOT_FOUND commitmentEnablerId, fromCalendarId, or toCalendarId not found or commitmentEnablerId not mapped to fromCalendarId
NULL_ARGUMENT commitmentEnablerId, fromCalendarId, or toCalendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.