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

This session provides methods to apply SupersedingEventEnablers to SupersedingEvents. A SupersedingEvent with multiple SupersedingEventEnablers means any positive rule evaluation across the enablers result in an effective SupersedingEvent.

MethodgetCalendarId
Description

Gets the Calendar Id associated with this session.

Returnosid.id.Idthe Calendar Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCalendar
Description

Gets the Calendar associated with this session.

Returnosid.calendaring.Calendarthe calendar
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignSupersedingEventEnablers
Description

Tests if this user can alter superseding event enabler/superseding event 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
CompliancemandatoryThis method must be implemented.
MethodassignSupersedingEventEnablerToSupersedingEvent
Description

Adds an existing SupersedingEventEnabler to a SupersedingEvent.

Parametersosid.id.IdsupersedingEventEnablerIdthe Id of the SupersedingEventEnabler
osid.id.IdsupersedingEventIdthe Id of the SupersedingEvent
ErrorsALREADY_EXISTS supersedingEventEnablerId already applied to supersedingEventId
NOT_FOUND supersedingEventEnablerId or supersedingEventId not found
NULL_ARGUMENT supersedingEventEnablerId or supersedingEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSupersedingEventEnablerFromSupersedingEvent
Description

Removes a SupersedingEventEnabler from a SupersedingEvent.

Parametersosid.id.IdsupersedingEventEnablerIdthe Id of the SupersedingEventEnabler
osid.id.IdsupersedingEventIdthe Id of the Calendar
ErrorsNOT_FOUND supersedingEventEnablerId or supersedingEventId not found or supersedingEventEnablerId not applied to supersedingEventId
NULL_ARGUMENT supersedingEventEnablerId or supersedingEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceSupersedingEventEnablers
Description

Tests if this user can order SupersedingEventEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if SupersedingEventEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveSupersedingEventEnablerAhead
Description

Reorders superseding event enablers for a superseding event by moving the specified superseding event enabler in front of a reference superseding event enabler.

Parametersosid.id.IdsupersedingEventEnablerIdthe Id of a SupersedingEventEnabler
osid.id.IdsupersedingEventIdthe Id of a SupersedingEvent
osid.id.IdreferenceIdthe reference superseding event enabler Id
ErrorsNOT_FOUND supersedingEventEnablerId, supersedingEventId, or referenceId not found or, supersedingEventEnablerId or referenceId not related to supersedingEventId
NULL_ARGUMENT supersedingEventEnablerId, supersedingEventId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveSupersedingEventEnablerBehind
Description

Reorders superseding event enablers for a superseding event by moving the specified superseding event enabler behind a reference superseding event enabler.

Parametersosid.id.IdsupersedingEventEnablerIdthe Id of a SupersedingEventEnabler
osid.id.IdsupersedingEventIdthe Id of a SupersedingEvent
osid.id.IdreferenceIdthe reference superseding event enabler Id
ErrorsNOT_FOUND supersedingEventEnablerId, supersedingEventId, or referenceId not found or, supersedingEventEnablerId or referenceId not related to supersedingEventId
NULL_ARGUMENT supersedingEventEnablerId, supersedingEventId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderSupersedingEventEnablers
Description

Reorders a set of superseding event enablers for a superseding event.

Parametersosid.id.Id[]supersedingEventEnablerIdsthe Ids for a set of SupersedingEventEnablerIds
osid.id.IdsupersedingEventIdthe Id of a SupersedingEvent
ErrorsNOT_FOUND supersedingEventId not found or, an supersedingEventEnablerId not related to supersedingEventId
NULL_ARGUMENT supersedingEventEnablerIds or supersedingEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.