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

This session provides methods to re-assign RecurringEventEnabler to Calendar mappings. A RecurringEventEnabler may appear in multiple Calendar objects and removing the last reference to a RecurringEventEnabler 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 RecurringEventEnabler to another Calendar is not a copy operation (eg: does not change its Id ).

MethodcanAssignRecurringEventEnablers
Description

Tests if this user can alter recurring event 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.
MethodcanAssignRecurringEventEnablersToCalendar
Description

Tests if this user can alter recurring event 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 recurring event 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.
MethodgetAssignableCalendarIdsForRecurringEventEnabler
Description

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

Parametersosid.id.IdcalendarIdthe Id of the Calendar
osid.id.IdrecuringEventEnablerIdthe Id of the RecurringEventEnabler
Returnosid.id.IdListlist of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId or recurringEventEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRecurringEventEnablerToCalendar
Description

Adds an existing RecurringEventEnabler to an Calendar.

Parametersosid.id.IdrecurringEventEnablerIdthe Id of the RecurringEventEnabler
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsALREADY_EXISTS recurringEventEnablerId already mapped to calendarId
NOT_FOUND recurringEventEnablerId or calendarId not found
NULL_ARGUMENT recurringEventEnablerId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignRecurringEventEnablerFromCalendar
Description

Removes a RecurringEventEnabler from an Calendar.

Parametersosid.id.IdrecurringEventEnablerIdthe Id of the RecurringEventEnabler
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsNOT_FOUND recurringEventEnablerId or calendarId not found or recurringEventEnablerId not assigned to calendarId
NULL_ARGUMENT recurringEventEnablerId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.