public interface TimePeriodBatchAdminSession extends TimePeriodAdminSession
This session creates, updates, and deletes TimePeriods
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
TimePeriod,
a TimePeriodForm
is requested using
getTimePeriodFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed.
Each of the returned TimePeriodForms
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 TimePeriodForm
is submiited to a create operation, it cannot be reused with another
create operation unless the first operation was unsuccessful. Each
TimePeriodForm
corresponds to an attempted transaction.
The TimePeriodForms
returned from
getTimePeriodFormsForCreate()
may be linked to the originating
request through the peer Ids
of the TimePeriodForm.
In the case where there may be duplicates, any
TimePeriodForm
of the same peer Ids
may be used for
a create operation.
Once a batch of TimePeriodForms
are submitted for
create, a CreateResponse
is returned for each
TimePeriodForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createTimePeriods(),
errors specific to an individual
TimePeriodForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating TimePeriodForm
through the
TimePeriodForm
Id
.
For updates, TimePeriodForms
are requested to the
TimePeriod
Id
that is to be updated using
getTimePeriodFormsForUpdate()
where the reference Id
in the TimePeriodForm
may be used to link the
request. Similarly, the TimePeriodForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The TimePeriodForm
can only be used
once for a successful update and cannot be reused.
Once a batch of TimePeriodForms
are submitted for
update, an UpdateResponse
is returned for each
TimePeriodForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateTimePeriods(),
errors specific to an individual
TimePeriodForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating TimePeriodForm
through the
TimePeriodForm
Id.
The delete operations delete TimePeriods
in bulk. To
unmap a TimePeriod
from the current Calendar,
the TimePeriodCalendarAssignmentSession
should be
used. These delete operations attempt to remove the TimePeriod
itself thus removing it from all known Calendar
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasTimePeriods(AliasRequestList aliasRequests)
Adds an
Id to a TimePeriod for the
purpose of creating compatibility. |
CreateResponseList |
createTimePeriods(TimePeriodBatchFormList timePeriodForms)
Creates a new set of
TimePeriods. |
DeleteResponseList |
deleteAllTimePeriods()
Deletes all
TimePeriods in this Calendar
. |
DeleteResponseList |
deleteTimePeriods(IdList timePeriodIds)
Deletes time periods for the given
Ids. |
DeleteResponseList |
deleteTimePeriodsByDate(DateTime date)
Deletes time periods containing the given date.
|
TimePeriodBatchFormList |
getTimePeriodFormsForCreate(long number,
Type[] timePeriodRecordTypes)
Gets the time period forms for creating a bunch of new time periods.
|
TimePeriodBatchFormList |
getTimePeriodFormsForUpdate(IdList timePeriodIds)
Gets the time period forms for updating an existing set of time
periods.
|
UpdateResponseList |
updateTimePeriods(TimePeriodBatchFormList timePeriodForms)
Updates existing time periods.
|
addExceptionEvent, aliasTimePeriod, canCreateTimePeriods, canCreateTimePeriodWithRecordTypes, canDeleteTimePeriods, canManageTimePeriodAliases, canUpdateTimePeriods, createTimePeriod, deleteTimePeriod, getCalendar, getCalendarId, getTimePeriodFormForCreate, getTimePeriodFormForUpdate, removeExceptionEvent, updateTimePeriod
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
TimePeriodBatchFormList getTimePeriodFormsForCreate(long number, Type[] timePeriodRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievetimePeriodRecordTypes
- array of time period record types to be
included in each create operation or an empty list if noneNullArgumentException
- timePeriodRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createTimePeriods(TimePeriodBatchFormList timePeriodForms) throws OperationFailedException, PermissionDeniedException
TimePeriods.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.timePeriodForms
- the time period formsNullArgumentException
- timePeriodForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TimePeriodBatchFormList getTimePeriodFormsForUpdate(IdList timePeriodIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
timePeriodIds
- the Ids
of the TimePeriod
NotFoundException
- a timePeriodId
is
not foundNullArgumentException
- timePeriodIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateTimePeriods(TimePeriodBatchFormList timePeriodForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.timePeriodForms
- the form containing the elements to be updatedNullArgumentException
- timePeriodForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllTimePeriods() throws OperationFailedException, PermissionDeniedException
TimePeriods
in this Calendar
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteTimePeriods(IdList timePeriodIds) throws OperationFailedException, PermissionDeniedException
Ids.
timePeriodIds
- the Ids
of the time periods to
deleteNullArgumentException
- timePeriodIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteTimePeriodsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasTimePeriods(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a TimePeriod
for the
purpose of creating compatibility. The primary Id
of
the TimePeriod
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another time period, it is reassigned to the
given time period Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.