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

This session creates, updates, and deletes Cyclic Events. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a CyclicEvent, a CyclicEventForm is requested using getCyclicEventFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned CycllicEventForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the CyclicEventForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CyclicEventForm corresponds to an attempted transaction.

For updates, CycliccEventForms are requested to the CyclicEvent Id that is to be updated using getCyclicEventFormForUpdate(). Similarly, the CyclicEventForm has metadata about the data that can be updated and it can perform validation before submitting the update. The CyclicEventForm can only be used once for a successful update and cannot be reused.

The delete operations delete Cyclic Events. To unmap a CyclicEvent from the current Calendar, the CyclicEventCalendarAssignmentSession should be used. These delete operations attempt to remove the CyclicEvent itself thus removing it from all known Calendar catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

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 associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateCyclicEvents
Description

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

Returnboolean false if CyclicEvent creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateCyclicEventWithRecordTypes
Description

Tests if this user can create a single CyclicEvent using the desired record types. While CalendaringCycleManager.getCyclicEventRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific CyclicEvent. Providing an empty array tests if a CyclicEvent can be created with no records.

Parametersosid.type.Type[]cyclicEventRecordTypesarray of cyclic event record types
Returnboolean true if CyclicEvent creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT cyclicEventRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventFormForCreate
Description

Gets the cyclic event form for creating new cyclic events. A new form should be requested for each create transaction.

Parametersosid.type.Type[]cyclicEventRecordTypesarray of cyclic event record types
Returnosid.calendaring.cycle.CyclicEventFormthe cyclic event form
ErrorsNULL_ARGUMENT cyclicEventRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateCyclicEvent
Description

Creates a new CyclicEvent.

Parametersosid.calendaring.cycle.CyclicEventFormcyclicEventFormthe form for this CyclicEvent
Returnosid.calendaring.cycle.CyclicEventthe new CyclicEvent
ErrorsILLEGAL_STATE cyclicEventForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT cyclicEventForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED cyclicEventForm did not originate from getCyclicEventFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateCyclicEvents
Description

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

Returnboolean false if cyclic event modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventFormForUpdate
Description

Gets the cyclic event form for updating an existing cyclic event. A new event form should be requested for each update transaction.

Parametersosid.id.IdcyclicEventIdthe Id of the CyclicEvent
Returnosid.calendaring.cycle.CyclicEventFormthe cyclic event form
ErrorsNOT_FOUND cyclicEventId is not found
NULL_ARGUMENT cyclicEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCyclicEvent
Description

Updates an existing cyclic event.

Parametersosid.calendaring.cycle.CyclicEventFormcyclicEventFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE cyclicEventForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT cyclicEventForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED cyclicEventForm did not originate from getCyclicEventFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteCyclicEvents
Description

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

Returnboolean false if CyclicEvent deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteCyclicEvent
Description

Deletes the CyclicEvent identified by the given Id.

Parametersosid.id.IdcyclicEventIdthe Id of the CyclicEvent to delete
ErrorsNOT_FOUNDa CyclicEvent was not found identified by the given Id
NULL_ARGUMENT cyclicEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageCyclicEventAliases
Description

Tests if this user can manage Id aliases for CyclicEvents. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if CyclicEvent aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasCyclicEvent
Description

Adds an Id to a CyclicEvent for the purpose of creating compatibility. The primary Id of the CyclicEvent is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another cyclic event, it is reassigned to the given cyclic event Id.

Parametersosid.id.IdcyclicEventIdthe Id of a CyclicEvent
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND cyclicEventId not found
NULL_ARGUMENT cyclicEventId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.