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

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

MethodcanAssignRecurringEvents
Description

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

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

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

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

Adds an existing RecurringEvent to a Calendar.

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

Removes a RecurringEvent from a Calendar.

Parametersosid.id.IdrecurringEventIdthe Id of the RecurringEvent
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsNOT_FOUND recurringEventId or calendarId not found or recurringEventId not assigned to calendarId
NULL_ARGUMENT recurringEventId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignRecurringEventToCalendar
Description

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

Parametersosid.id.IdrecurringEventIdthe Id of the RecurringtEvent
osid.id.IdfromBillingIdthe Id of the current Calendar
osid.id.IdtoBiillingIdthe Id of the destination Calendar
ErrorsNOT_FOUND recurringEventId, fromCalendarId, or toCalendarId not found or recurringEventId not mapped to fromCalendarId
NULL_ARGUMENT recurringEventId, fromCalendarId, or toCalendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.