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

This session creates, updates, and deletes 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 an Event, an EventForm is requested using getEventFormForCreate() specifying the desired and record Types or none if no record Types are needed. The returned EventForm 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 EventForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each EventForm corresponds to an attempted transaction.

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

The delete operations delete Events. To unmap an Event from the current Calendar, the EventCalendarAssignmentSession should be used. These delete operations attempt to remove the Event 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.
MethodcanCreateEvents
Description

Tests if this user can create Events. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Event 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 Event creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateEventWithRecordTypes
Description

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

Parametersosid.type.Type[]eventRecordTypesarray of event record types
Returnboolean true if Event creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT eventRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetEventFormForCreate
Description

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

Parametersosid.type.Type[]eventRecordTypesarray of event record types
Returnosid.calendaring.EventFormthe event form
ErrorsNULL_ARGUMENT eventRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateEvent
Description

Creates a new Event.

Parametersosid.calendaring.EventFormeventFormthe form for this Event
Returnosid.calendaring.Eventthe new Event
ErrorsILLEGAL_STATE eventForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT eventForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED eventForm did not originate from getEventFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateEvents
Description

Tests if this user can update Events. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Event 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 event modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEventFormForUpdate
Description

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

Parametersosid.id.IdeventIdthe Id of the Event
Returnosid.calendaring.EventFormthe event form
ErrorsNOT_FOUND eventId is not found
NULL_ARGUMENT eventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateEvent
Description

Updates an existing event.

Parametersosid.calendaring.EventFormeventFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE eventForm already used in an update transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT eventForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED eventForm did not originate from getEventFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteEvents
Description

Tests if this user can delete Events. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Event 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 Event deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteEvent
Description

Deletes the Event identified by the given Id.

Parametersosid.id.IdeventIdthe Id of the Event to delete
ErrorsNOT_FOUNDan Event was not found identified by the given Id
NULL_ARGUMENT eventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageEventAliases
Description

Tests if this user can manage Id aliases for Events. 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 Event aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasEvent
Description

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

Parametersosid.id.IdeventIdthe Id of an Event
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND eventId not found
NULL_ARGUMENT eventId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.