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.
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.
|
aliasEvent, canCreateEvents, canCreateEventWithRecordTypes, canDeleteEvents, canManageEventAliases, canUpdateEvents, createEvent, deleteEvent, getCalendar, getCalendarId, getEventFormForCreate, getEventFormForUpdate, updateEvent
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
EventBatchFormList getEventFormsForCreate(long number, Type[] eventRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveeventRecordTypes
- array of event record types to be included in
each create operation or an empty list if noneNullArgumentException
- eventRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createEvents(EventBatchFormList eventForms) throws OperationFailedException, PermissionDeniedException
Events.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.eventForms
- the event formsNullArgumentException
- eventForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EventBatchFormList getEventFormsForUpdate(IdList eventIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
eventIds
- the Ids
of the Event
NotFoundException
- an eventId
is not
foundNullArgumentException
- eventIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateEvents(EventBatchFormList eventForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.eventForms
- the form containing the elements to be updatedNullArgumentException
- eventForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllEvents() throws OperationFailedException, PermissionDeniedException
Events
in this Calendar
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteEvents(IdList eventIds) throws OperationFailedException, PermissionDeniedException
Ids.
eventIds
- the Ids
of the events to deleteNullArgumentException
- eventIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasEvents(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.