org.osid.calendaring.batch

Interface EventBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, EventAdminSession, OsidSession

public interface EventBatchAdminSession
extends EventAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasEvents(AliasRequestList aliasRequests) Adds an Id to an Event for the purpose of creating compatibility.
CreateResponseList	createEvents(EventBatchFormList eventForms) Creates a new set of Events.
DeleteResponseList	deleteAllEvents() Deletes all Events in this Calendar .
DeleteResponseList	deleteEvents(IdList eventIds) Deletes events for the given Ids.
EventBatchFormList	getEventFormsForCreate(long number, Type[] eventRecordTypes) Gets the event forms for creating a bunch of new events.
EventBatchFormList	getEventFormsForUpdate(IdList eventIds) Gets the event forms for updating an existing set of events.
UpdateResponseList	updateEvents(EventBatchFormList eventForms) Updates existing events.

Methods inherited from interface org.osid.calendaring.EventAdminSession

aliasEvent, canCreateEvents, canCreateEventWithRecordTypes, canDeleteEvents, canManageEventAliases, canUpdateEvents, createEvent, deleteEvent, getCalendar, getCalendarId, getEventFormForCreate, getEventFormForUpdate, updateEvent

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getEventFormsForCreate

EventBatchFormList getEventFormsForCreate(long number,
                                        Type[] eventRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

eventRecordTypes - array of event record types to be included in each create operation or an empty list if none

Returns:

the event forms

Throws:

NullArgumentException - eventRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createEvents

CreateResponseList createEvents(EventBatchFormList eventForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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 .

Parameters:

eventForms - the event forms

Returns:

the create responses

Throws:

NullArgumentException - eventForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEventFormsForUpdate

EventBatchFormList getEventFormsForUpdate(IdList eventIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

eventIds - the Ids of the Event

Returns:

the event form

Throws:

NotFoundException - an eventId is not found

NullArgumentException - eventIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateEvents

UpdateResponseList updateEvents(EventBatchFormList eventForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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 .

Parameters:

eventForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - eventForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllEvents

DeleteResponseList deleteAllEvents()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Events in this Calendar .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteEvents

DeleteResponseList deleteEvents(IdList eventIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes events for the given Ids.

Parameters:

eventIds - the Ids of the events to delete

Returns:

the delete responses

Throws:

NullArgumentException - eventIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasEvents

AliasResponseList aliasEvents(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.