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

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

MethodcanAssignSupersedingEvents
Description

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

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

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

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

Adds an existing SupersedingEvent to a Calendar.

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

Removes a SupersedingEvent from a Calendar.

Parametersosid.id.IdsupersedingEventIdthe Id of the SupersedingEvent
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsNOT_FOUND supersedingEventId or calendarId not found or supersedingEventId not assigned to calendarId
NULL_ARGUMENT supersedingEventId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignSupersedingEventToCalendar
Description

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

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