public interface CyclicTimePeriodBatchAdminSession extends CyclicTimePeriodAdminSession
This session creates, updates, and deletes CyclicTimePeriods
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
CyclicTimePeriod,
a CyclicTimePeriodForm
is
requested using getCyclicTimePeriodFormsForCreate()
specifying the desired record Types
or none if no record
Types
are needed. Each of the returned
CyclicTimePeriodForms
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 CyclicTimePeriodForm
is submiited to a
create operation, it cannot be reused with another create operation unless
the first operation was unsuccessful. Each CyclicTimePeriodForm
corresponds to an attempted transaction.
The CyclicTimePeriodForms
returned from
getCyclicTimePeriodFormsForCreate()
may be linked to the
originating request through the peer Ids
of the
CyclicTimePeriodForm.
In the case where there may be duplicates,
any CyclicTimePeriodForm
of the same peer Ids
may be used for a create operation.
Once a batch of CyclicTimePeriodForms
are submitted for
create, a CreateResponse
is returned for each
CyclicTimePeriodForm,
although the ordering is not defined. Only
errors that pertain to the entire create operation are returned from
createCyclicTimePeriods(),
errors specific to an individual
CyclicTimePeriodForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be
linked to the originating CyclicTimePeriodForm
through the
CyclicTimePeriodForm
Id
.
For updates, CyclicTimePeriodForms
are requested to the
CyclicTimePeriod
Id
that is to be updated
using getCyclicTimePeriodFormsForUpdate()
where the
reference Id
in the CyclicTimePeriodForm
may
be used to link the request. Similarly, the CyclicTimePeriodForm
has metadata about the data that can be updated and it can perform
validation before submitting the update. The CyclicTimePeriodForm
can only be used once for a successful update and cannot be
reused.
Once a batch of CyclicTimePeriodForms
are submitted for
update, an UpdateResponse
is returned for each
CyclicTimePeriodForm,
although the ordering is not defined. Only
errors that pertain to the entire update operation are returned from
updateCyclicTimePeriods(),
errors specific to an individual
CyclicTimePeriodForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be
linked to the originating CyclicTimePeriodForm
through the
CyclicTimePeriodForm
Id.
The delete operations delete CyclicTimePeriods
in bulk.
To unmap a CyclicTimePeriod
from the current
Calendar,
the CyclicTimePeriodCalendarAssignmentSession
should be used. These delete operations attempt to remove the
CyclicTimePeriod
itself thus removing it from all known
Calendar
catalogs. Bulk delete operations return the
results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasCyclicTimePeriods(AliasRequestList aliasRequests)
Adds an
Id to a CyclicTimePeriod for the
purpose of creating compatibility. |
CreateResponseList |
createCyclicTimePeriods(CyclicTimePeriodBatchFormList cyclicTimePeriodForms)
Creates a new set of
CyclicTimePeriods. |
DeleteResponseList |
deleteAllCyclicTimePeriods()
Deletes all
CyclicTimePeriods in this Calendar
. |
DeleteResponseList |
deleteCyclicTimePeriods(IdList cyclicTimePeriodIds)
Deletes cyclic time periods for the given
Ids. |
CyclicTimePeriodBatchFormList |
getCyclicTimePeriodFormsForCreate(long number,
Type[] cyclicTimePeriodRecordTypes)
Gets the cyclic time period forms for creating a bunch of new cyclic
time periods.
|
CyclicTimePeriodBatchFormList |
getCyclicTimePeriodFormsForUpdate(IdList cyclicTimePeriodIds)
Gets the cyclic time period forms for updating an existing set of
cyclic time periods.
|
UpdateResponseList |
updateCyclicTimePeriods(CyclicTimePeriodBatchFormList cyclicTimePeriodForms)
Updates existing cyclic time periods.
|
aliasCyclicTimePeriod, canCreateCyclicTimePeriods, canCreateCyclicTimePeriodWithRecordTypes, canDeleteCyclicTimePeriods, canManageCyclicTimePeriodAliases, canUpdateCyclicTimePeriods, createCyclicTimePeriod, deleteCyclicTimePeriod, getCalendar, getCalendarId, getCyclicTimePeriodFormForCreate, getCyclicTimePeriodFormForUpdate, updateCyclicTimePeriod
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CyclicTimePeriodBatchFormList getCyclicTimePeriodFormsForCreate(long number, Type[] cyclicTimePeriodRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievecyclicTimePeriodRecordTypes
- array of cyclic time period record
types to be included in each create operation or an empty list
if noneNullArgumentException
-
cyclicTimePeriodRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createCyclicTimePeriods(CyclicTimePeriodBatchFormList cyclicTimePeriodForms) throws OperationFailedException, PermissionDeniedException
CyclicTimePeriods.
This method
returns an error if the entire operation fails. Otherwise, the status
of an individual create operation is indicated in the
BatchCreateResponse
.cyclicTimePeriodForms
- the cyclic time period formsNullArgumentException
- cyclicTimePeriodForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CyclicTimePeriodBatchFormList getCyclicTimePeriodFormsForUpdate(IdList cyclicTimePeriodIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
cyclicTimePeriodIds
- the Ids
of the
CyclicTimePeriod
NotFoundException
- a cyclicTimePeriodId
is not foundNullArgumentException
- cyclicTimePeriodIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateCyclicTimePeriods(CyclicTimePeriodBatchFormList cyclicTimePeriodForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.cyclicTimePeriodForms
- the form containing the elements to be
updatedNullArgumentException
- cyclicTimePeriodForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllCyclicTimePeriods() throws OperationFailedException, PermissionDeniedException
CyclicTimePeriods
in this Calendar
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCyclicTimePeriods(IdList cyclicTimePeriodIds) throws OperationFailedException, PermissionDeniedException
Ids.
cyclicTimePeriodIds
- the Ids
of the cyclic time
periods to deleteNullArgumentException
- cyclicTimePeriodIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasCyclicTimePeriods(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a CyclicTimePeriod
for the
purpose of creating compatibility. The primary Id
of
the CyclicTimePeriod
is determined by the provider. The
new Id
is an alias to the primary Id.
If
the alias is a pointer to another cyclic time period, it is reassigned
to the given cyclic time period Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.