OSID Logo
OSID Specifications
calendaring rules package
Version 3.1.0
Interfaceosid.calendaring.rules.OffsetEventEnablerCalendarAssignmentSession
Implementsosid.OsidSession
Used Byosid.calendaring.rules.CalendaringRulesManager
osid.calendaring.rules.CalendaringRulesProxyManager
Description

This session provides methods to re-assign OffsetEventEnabler to Calendar mappings. An OffsetEventEnabler may appear in multiple Calendar objects and removing the last reference to an OffsetEventEnabler is the equivalent of deleting it. Each Calendar may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an OffsetEventEnabler to another Calendar is not a copy operation (eg: does not change its Id).

MethodcanAssignOffsetEventEnablers
Description

Tests if this user can alter offset event enabler/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 lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignOffsetEventEnablersToCalendar
Description

Tests if this user can alter offset event enabler/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 lookup 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 offset event enabler 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.
MethodgetAssignableCalendarIdsForOffsetEventEnabler
Description

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

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

Adds an existing OffsetEventEnabler to an Calendar.

Parametersosid.id.IdoffsetEventEnablerId the Id of the OffsetEventEnabler
osid.id.IdcalendarId the Id of the Calendar
ErrorsALREADY_EXISTS offsetEventEnablerId already mapped to calendarId
NOT_FOUND offsetEventEnablerId or calendarId not found
NULL_ARGUMENT offsetEventEnablerId or calendarId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignOffsetEventEnablerFromCalendar
Description

Removes an OffsetEventEnabler from an Calendar.

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

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

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