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

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

MethodcanAssignCyclicEvents
Description

Tests if this user can alter cyclic event/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 assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignCyclicEventsToCalendar
Description

Tests if this user can alter cyclic event/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 assignment 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 cyclic event 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.
MethodgetAssignableCalendarIdsForCyclicEvent
Description

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

Parametersosid.id.IdcalendarIdthe Id of the Calendar
osid.id.IdcyclicEventIdthe Id of the CyclicEvent
Returnosid.id.IdListlist of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId or cyclicEventId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignCyclicEventToCalendar
Description

Adds an existing CyclicEvent to a Calendar.

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

Removes a CyclicEvent from a Calendar.

Parametersosid.id.IdcyclicEventIdthe Id of the CyclicEvent
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsNOT_FOUND cyclicEventId or calendarId not found or cyclicEventId not assigned to calendarId
NULL_ARGUMENT cyclicEventId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignCyclicEventToCalendar
Description

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

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