public interface ScheduleSlotBatchAdminSession extends ScheduleSlotAdminSession
This session creates, updates, and deletes ScheduleSlots
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
ScheduleSlot,
a ScheduleSlotForm
is requested using
getScheduleSlotFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned ScheduleSlotForms
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
ScheduleSlotForm
is submiited to a create operation, it cannot be
reused with another create operation unless the first operation was
unsuccessful. Each ScheduleSlotForm
corresponds to an
attempted transaction.
The ScheduleSlotForms
returned from
getScheduleSlotFormsForCreate()
may be linked to the originating
request through the peer Ids
of the
ScheduleSlotForm.
In the case where there may be duplicates, any
ScheduleSlotForm
of the same peer Ids
may be
used for a create operation.
Once a batch of ScheduleSlotForms
are submitted for
create, a CreateResponse
is returned for each
ScheduleSlotForm,
although the ordering is not defined. Only
errors that pertain to the entire create operation are returned from
createScheduleSlots(),
errors specific to an individual
ScheduleSlotForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating ScheduleSlotForm
through the
ScheduleSlotForm
Id
.
For updates, ScheduleSlotForms
are requested to the
ScheduleSlot
Id
that is to be updated using
getScheduleSlotFormsForUpdate()
where the reference
Id
in the ScheduleSlotForm
may be used to link the
request. Similarly, the ScheduleSlotForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The ScheduleSlotForm
can only be
used once for a successful update and cannot be reused.
Once a batch of ScheduleSlotForms
are submitted for
update, an UpdateResponse
is returned for each
ScheduleSlotForm,
although the ordering is not defined. Only
errors that pertain to the entire update operation are returned from
updateScheduleSlots(),
errors specific to an individual
ScheduleSlotForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating ScheduleSlotForm
through the
ScheduleSlotForm
Id.
The delete operations delete ScheduleSlots
in bulk. To
unmap a ScheduleSlot
from the current Calendar,
the ScheduleSlotCalendarAssignmentSession
should be
used. These delete operations attempt to remove the ScheduleSlot
itself thus removing it from all known Calendar
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasScheduleSlots(AliasRequestList aliasRequests)
Adds an
Id to a ScheduleSlot for the
purpose of creating compatibility. |
CreateResponseList |
createScheduleSlots(ScheduleSlotBatchFormList scheduleSlotForms)
Creates a new set of
ScheduleSlots. |
DeleteResponseList |
deleteAllScheduleSlots()
Deletes all
ScheduleSlots in this Calendar
. |
DeleteResponseList |
deleteContainedScheduleSlots(Id scheduleSlotId)
Deletes schedule slots contained within the given schedule slot.
|
DeleteResponseList |
deleteScheduleSlots(IdList scheduleSlotIds)
Deletes schedule slots for the given
Ids. |
ScheduleSlotBatchFormList |
getScheduleSlotFormsForCreate(long number,
Type[] scheduleSlotRecordTypes)
Gets the schedule slot forms for creating a bunch of new schedule
slots.
|
ScheduleSlotBatchFormList |
getScheduleSlotFormsForUpdate(IdList scheduleSlotIds)
Gets the schedule slot forms for updating an existing set of schedule
slots.
|
UpdateResponseList |
updateScheduleSlots(ScheduleSlotBatchFormList scheduleSlotForms)
Updates existing schedule slots.
|
aliasScheduleSlot, canCreateScheduleSlots, canCreateScheduleSlotWithRecordTypes, canDeleteScheduleSlots, canManageScheduleSlotAliases, canUpdateScheduleSlots, createScheduleSlot, deleteScheduleSlot, getCalendar, getCalendarId, getScheduleSlotFormForCreate, getScheduleSlotFormForUpdate, updateScheduleSlot
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ScheduleSlotBatchFormList getScheduleSlotFormsForCreate(long number, Type[] scheduleSlotRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievescheduleSlotRecordTypes
- array of schedule slot record types to
be included in each create operation or an empty list if noneNullArgumentException
- scheduleSlotRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createScheduleSlots(ScheduleSlotBatchFormList scheduleSlotForms) throws OperationFailedException, PermissionDeniedException
ScheduleSlots.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.scheduleSlotForms
- the schedule slot formsNullArgumentException
- scheduleSlotForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleSlotBatchFormList getScheduleSlotFormsForUpdate(IdList scheduleSlotIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
scheduleSlotIds
- the Ids
of the
ScheduleSlot
NotFoundException
- a scheduleSlotId
is
not foundNullArgumentException
- scheduleSlotIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateScheduleSlots(ScheduleSlotBatchFormList scheduleSlotForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.scheduleSlotForms
- the form containing the elements to be
updatedNullArgumentException
- scheduleSlotForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllScheduleSlots() throws OperationFailedException, PermissionDeniedException
ScheduleSlots
in this Calendar
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteScheduleSlots(IdList scheduleSlotIds) throws OperationFailedException, PermissionDeniedException
Ids.
scheduleSlotIds
- the Ids
of the schedule slots
to deleteNullArgumentException
- scheduleSlotIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteContainedScheduleSlots(Id scheduleSlotId) throws OperationFailedException, PermissionDeniedException
scheduleSlotId
- the Id
of a schedule slotNullArgumentException
- scheduleSlotId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasScheduleSlots(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a ScheduleSlot
for the
purpose of creating compatibility. The primary Id
of
the ScheduleSlot
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another schedule slot, it is reassigned to the
given schedule slot Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.