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

This session creates, updates, and deletes Events in bulk. 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 getEventFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned EventForms 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 an 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.

The EventForms returned from getEventFormsForCreate() may be linked to the originating request through the peer Ids of the EventForm. In the case where there may be duplicates, any EventForm of the same peer Ids may be used for a create operation.

Once a batch of EventForms are submitted for create, a CreateResponse is returned for each EventForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createEvents(), errors specific to an individual EventForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating EventForm through the EventForm Id .

For updates, EventForms are requested to the Event Id that is to be updated using getEventFormsForUpdate() where the reference Id in the EventForm may be used to link the request. 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.

Once a batch of EventForms are submitted for update, an UpdateResponse is returned for each EventForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateEvents(), errors specific to an individual EventForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating EventForm through the EventForm Id.

The delete operations delete Events in bulk. 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. Bulk delete operations return the results in DeleteResponses.

MethodgetEventFormsForCreate
Description

Gets the event forms for creating a bunch of new events.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]eventRecordTypesarray of event record types to be included in each create operation or an empty list if none
Returnosid.calendaring.batch.EventBatchFormListthe event forms
ErrorsNULL_ARGUMENT eventRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateEvents
Description

Creates a new set of Events. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.calendaring.batch.EventBatchFormListeventFormsthe event forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT eventForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEventFormsForUpdate
Description

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

Parametersosid.id.IdListeventIdsthe Ids of the Event
Returnosid.calendaring.batch.EventBatchFormListthe event form
ErrorsNOT_FOUNDan eventId is not found
NULL_ARGUMENT eventIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateEvents
Description

Updates existing events. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.calendaring.batch.EventBatchFormListeventFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT eventForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllEvents
Description

Deletes all Events in this Calendar .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteEvents
Description

Deletes events for the given Ids.

Parametersosid.id.IdListeventIdsthe Ids of the events to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT eventIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasEvents
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 is an alias to the primary Id. If the alias is a pointer to another event, it is reassigned to the given event Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.