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

This session provides methods to manually assign Events to CyclicEvents. An Event may be the product of a OsidRule originating from a SupersedingEvent, OffsetEvent, or a RecurringEvent in which case the CyclicEvent is applied to the rule.

MethodgetCalendarId
Description

Gets the Calendar Id associated with this session.

Returnosid.id.Idthe Calendar Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCalendar
Description

Gets the Calendar associated with this session.

Returnosid.calendaring.Calendarthe Calendar associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignEvents
Description

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

Tests if this user can alter event/cyclic event 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.IdcyclicEventIdthe Id of the CyclicEvent
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT cyclicEventId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCyclicEventIds
Description

Gets a list of cyclic event Ids.

Returnosid.id.IdListlist of assignable cyclic event Ids
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignEventToCyclicEvent
Description

Adds an existing Event to a CyclicEvent.

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

Removes an Event from a CyclicEvent.

Parametersosid.id.IdeventIdthe Id of the Event
osid.id.IdcyclicEventIdthe Id of the CyclicEvent
ErrorsNOT_FOUND eventId or cyclicEventId not found or eventId is not assigned to cyclicEventId
NULL_ARGUMENT eventId or cyclicEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.