OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.EventCalendarAssignmentSession
Implementsosid.OsidSession
Used Byosid.calendaring.CalendaringManager
osid.calendaring.CalendaringProxyManager
Description

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

MethodcanAssignEvents
Description

Tests if this user can alter 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
Compliancemandatory This method must be implemented.
MethodcanAssignEventsToCalendar
Description

Tests if this user can alter 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.IdcalendarId the Id of the Calendar
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT calendarId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableCalendarIds
Description

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

Parametersosid.id.IdcalendarId the Id of the Calendar
Returnosid.id.IdList list of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableCalendarIdsForEvent
Description

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

Parametersosid.id.IdcalendarId the Id of the Calendar
osid.id.IdeventId the Id of the Event
Returnosid.id.IdList list of assignable calendar Ids
ErrorsNULL_ARGUMENT calendarId or eventId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignEventToCalendar
Description

Adds an existing Event to a Calendar.

Parametersosid.id.IdeventId the Id of the Event
osid.id.IdcalendarId the Id of the Calendar
ErrorsALREADY_EXISTS eventId is already assigned to calendarId
NOT_FOUND eventId or calendarId not found
NULL_ARGUMENT eventId or calendarId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignEventFromCalendar
Description

Removes an Event from a Calendar.

Parametersosid.id.IdeventId the Id of the Event
osid.id.IdcalendarId the Id of the Calendar
ErrorsNOT_FOUND eventId or calendarId not found or eventId not assigned to calendarId
NULL_ARGUMENT eventId or calendarId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignEventToCalendar
Description

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

Parametersosid.id.IdeventId the Id of the Event
osid.id.IdfromCalendarId the Id of the current Calendar
osid.id.IdtoCalendarId the Id of the destination Calendar
ErrorsALREADY_EXISTS eventId already assigned to toCalendarId
NOT_FOUND eventId, fromCalendarId, or toCalendarId not found or eventId not mapped to fromCalendarId
NULL_ARGUMENT eventId, fromCalendarId, or toCalendarId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.