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

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

MethodcanAssignOffsetEvents
Description

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

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

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

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

Adds an existing OffsetEvent to a Calendar.

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

Removes an OffsetEvent from a Calendar.

Parametersosid.id.IdoffsetEventIdthe Id of the OffsetEvent
osid.id.IdcalendarIdthe Id of the Calendar
ErrorsNOT_FOUND offsetEventId or calendarId not found or offsetEventId not assigned to calendarId
NULL_ARGUMENT offsetEventId or calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignOffsetEventToCalendar
Description

Moves an OffsetEvent from one Calendar to another. Mappings to other Calendars are unaffected.

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