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

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

MethodcanAssignSupersedingEventEnablers
Description

Tests if this user can alter superseding 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.
MethodcanAssignSupersedingEventEnablersToCalendar
Description

Tests if this user can alter superseding 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 superseding 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.
MethodgetAssignableCalendarIdsForSupersedingEventEnabler
Description

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

Parametersosid.id.IdcalendarIdthe Id of the Calendar
osid.id.IdsupersedingEventEnablerIdthe Id of the SupersedingEventEnabler
Returnosid.id.IdListlist of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId or supersedingEventEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignSupersedingEventEnablerToCalendar
Description

Adds an existing SupersedingEventEnabler to an Calendar.

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

Removes a SupersedingEventEnabler from an Calendar.

Parametersosid.id.IdsupersedingEventEnablerIdthe Id of the SupersedingEventEnabler
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsNOT_FOUND supersedingEventEnablerId or calendarId not found or supersedingEventEnablerId not assigned to calendarId
NULL_ARGUMENT supersedingEventEnablerId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignSupersedingEventEnablerToCalendar
Description

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

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