public interface DepotBatchAdminSession extends DepotAdminSession
This session creates, updates, and deletes Depots
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
Depot,
an DepotForm
is requested using
getDepotFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed.
Each of the returned DepotForms
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 DepotForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
DepotForm
corresponds to an attempted transaction.
The DepotForms
returned from
getDepotFormsForCreate()
may be linked to the originating request
through the peer Ids
of the DepotForm.
In
the case where there may be duplicates, any DepotForm
of
the same peer Ids
may be used for a create operation.
Once a batch of DepotForms
are submitted for create, a
CreateResponse
is returned for each DepotForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createDepots(),
errors specific to an individual DepotForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating DepotForm
through the DepotForm
Id
.
For updates, DepotForms
are requested to the
Depot
Id
that is to be updated using
getDepotFormsForUpdate()
where the reference Id
in
the DepotForm
may be used to link the request. Similarly,
the DepotForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
DepotForm
can only be used once for a successful update and
cannot be reused.
Once a batch of DepotForms
are submitted for update, an
UpdateResponse
is returned for each DepotForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateDepots(),
errors specific to an individual DepotForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating DepotForm
through the DepotForm
Id.
The delete operations delete Depots
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasDepots(AliasRequestList aliasRequests)
Adds an
Id to an Depot for the purpose
of creating compatibility. |
CreateResponseList |
createDepots(DepotBatchFormList depotForms)
Creates a new set of
Depots. |
DeleteResponseList |
deleteAllDepots()
Deletes all
Depots. |
DeleteResponseList |
deleteDepots(IdList depotIds)
Deletes depots for the given
Ids. |
DepotBatchFormList |
getDepotFormsForCreate(long number,
Type[] depotRecordTypes)
Gets the depot forms for creating a bunch of new depots.
|
DepotBatchFormList |
getDepotFormsForUpdate(IdList depotIds)
Gets the depot forms for updating an existing set of depots.
|
UpdateResponseList |
updateDepots(DepotBatchFormList depotForms)
Updates existing depots.
|
aliasDepot, canCreateDepots, canCreateDepotWithRecordTypes, canDeleteDepot, canDeleteDepots, canManageDepotAliases, canUpdateDepot, canUpdateDepots, createDepot, deleteDepot, getDepotFormForCreate, getDepotFormForUpdate, updateDepot
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DepotBatchFormList getDepotFormsForCreate(long number, Type[] depotRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievedepotRecordTypes
- array of depot record types to be included in
each create operation or an empty list if noneNullArgumentException
- depotRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createDepots(DepotBatchFormList depotForms) throws OperationFailedException, PermissionDeniedException
Depots.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.depotForms
- the depot formsNullArgumentException
- depotForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DepotBatchFormList getDepotFormsForUpdate(IdList depotIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
depotIds
- the Ids
of the Depot
NotFoundException
- an depotId
is not
foundNullArgumentException
- depotIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateDepots(DepotBatchFormList depotForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.depotForms
- the form containing the elements to be updatedNullArgumentException
- depotForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllDepots() throws OperationFailedException, PermissionDeniedException
Depots.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteDepots(IdList depotIds) throws OperationFailedException, PermissionDeniedException
Ids.
depotIds
- the Ids
of the depots to deleteNullArgumentException
- depotIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasDepots(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Depot
for the purpose
of creating compatibility. The primary Id
of the
Depot
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another depot, it is reassigned to the given depot
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.