public interface CyclicEventBatchAdminSession extends CyclicEventAdminSession
This session creates, updates, and deletes CyclicEvents
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 a
CyclicEvent,
a CyclicEventForm
is requested using
getCyclicEventFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned CyclicEventForms
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 a 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.
The CyclicEventForms
returned from
getCyclicEventFormsForCreate()
may be linked to the originating
request through the peer Ids
of the CyclicEventForm.
In the case where there may be duplicates, any
CyclicEventForm
of the same peer Ids
may be used
for a create operation.
Once a batch of CyclicEventForms
are submitted for
create, a CreateResponse
is returned for each
CyclicEventForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createCyclicEvents(),
errors specific to an individual
CyclicEventForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating CyclicEventForm
through the
CyclicEventForm
Id
.
For updates, CyclicEventForms
are requested to the
CyclicEvent
Id
that is to be updated using
getCyclicEventFormsForUpdate()
where the reference
Id
in the CyclicEventForm
may be used to link the
request. 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.
Once a batch of CyclicEventForms
are submitted for
update, an UpdateResponse
is returned for each
CyclicEventForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateCyclicEvents(),
errors specific to an individual
CyclicEventForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating CyclicEventForm
through the
CyclicEventForm
Id.
The delete operations delete CyclicEvents
in bulk. 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. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasCyclicEvents(AliasRequestList aliasRequests)
Adds an
Id to a CyclicEvent for the
purpose of creating compatibility. |
CreateResponseList |
createCyclicEvents(CyclicEventBatchFormList cyclicEventForms)
Creates a new set of
CyclicEvents. |
DeleteResponseList |
deleteAllCyclicEvents()
Deletes all
CyclicEvents in this Calendar
. |
DeleteResponseList |
deleteCyclicEvents(IdList cyclicEventIds)
Deletes cyclic events for the given
Ids. |
CyclicEventBatchFormList |
getCyclicEventFormsForCreate(long number,
Type[] cyclicEventRecordTypes)
Gets the cyclic event forms for creating a bunch of new cyclic events.
|
CyclicEventBatchFormList |
getCyclicEventFormsForUpdate(IdList cyclicEventIds)
Gets the cyclic event forms for updating an existing set of cyclic
events.
|
UpdateResponseList |
updateCyclicEvents(CyclicEventBatchFormList cyclicEventForms)
Updates existing cyclic events.
|
aliasCyclicEvent, canCreateCyclicEvents, canCreateCyclicEventWithRecordTypes, canDeleteCyclicEvents, canManageCyclicEventAliases, canUpdateCyclicEvents, createCyclicEvent, deleteCyclicEvent, getCalendar, getCalendarId, getCyclicEventFormForCreate, getCyclicEventFormForUpdate, updateCyclicEvent
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CyclicEventBatchFormList getCyclicEventFormsForCreate(long number, Type[] cyclicEventRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievecyclicEventRecordTypes
- array of cyclic event record types to
be included in each create operation or an empty list if noneNullArgumentException
- cyclicEventRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createCyclicEvents(CyclicEventBatchFormList cyclicEventForms) throws OperationFailedException, PermissionDeniedException
CyclicEvents.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.cyclicEventForms
- the cyclic event formsNullArgumentException
- cyclicEventForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CyclicEventBatchFormList getCyclicEventFormsForUpdate(IdList cyclicEventIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
cyclicEventIds
- the Ids
of the
CyclicEvent
NotFoundException
- a cyclicEventId
is
not foundNullArgumentException
- cyclicEventIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateCyclicEvents(CyclicEventBatchFormList cyclicEventForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.cyclicEventForms
- the form containing the elements to be
updatedNullArgumentException
- cyclicEventForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllCyclicEvents() throws OperationFailedException, PermissionDeniedException
CyclicEvents
in this Calendar
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCyclicEvents(IdList cyclicEventIds) throws OperationFailedException, PermissionDeniedException
Ids.
cyclicEventIds
- the Ids
of the cyclic events to
deleteNullArgumentException
- cyclicEventIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasCyclicEvents(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a CyclicEvent
for the
purpose of creating compatibility. The primary Id
of
the CyclicEvent
is determined by the provider. The new
Id
is 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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.