OSID Logo
OSID Specifications
calendaring rules package
Version 3.1.0
Interfaceosid.calendaring.rules.RecurringEventEnablerCalendarAssignmentSession
Implementsosid.OsidSession
Used Byosid.calendaring.rules.CalendaringRulesManager
osid.calendaring.rules.CalendaringRulesProxyManager
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
Compliancemandatory This 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.IdcalendarId the Id of the Calendar
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT calendarId is null
Compliancemandatory This 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.IdcalendarId the Id of the Calendar
Returnosid.id.IdList list of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IdcalendarId the Id of the Calendar
osid.id.IdrecuringEventEnablerId the Id of the RecurringEventEnabler
Returnosid.id.IdList list of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId or recurringEventEnablerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignRecurringEventEnablerToCalendar
Description

Adds an existing RecurringEventEnabler to an Calendar.

Parametersosid.id.IdrecurringEventEnablerId the Id of the RecurringEventEnabler
osid.id.IdcalendarId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignRecurringEventEnablerFromCalendar
Description

Removes a RecurringEventEnabler from an Calendar.

Parametersosid.id.IdrecurringEventEnablerId the Id of the RecurringEventEnabler
osid.id.IdcalendarId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignRecurringEventEnablerToCalendar
Description

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

Parametersosid.id.IdrecuringEventEnablerId the Id of the RecurringEvent
osid.id.IdfromCalendarId the Id of the current Calendar
osid.id.IdtoCalendarId the Id of the destination Calendar
ErrorsALREADY_EXISTS recuringEventEnablerId already assigned to toCalendarId
NOT_FOUND recuringEventEnablerId, fromCalendarId or toCalendarId not found or recuringEventEnablerId not mapped to fromCalendarId
NULL_ARGUMENT recuringEventEnablerId, fromCalendarId, or toCalendarId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.