public interface DistributorBatchAdminSession extends DistributorAdminSession
This session creates, updates, and deletes Distributors
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
Distributor,
a DistributorForm
is requested using
getDistributorFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned DistributorForms
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 DistributorForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
DistributorForm
corresponds to an attempted transaction.
The DistributorForms
returned from
getDistributorFormsForCreate()
may be linked to the originating
request through the peer Ids
of the DistributorForm.
In the case where there may be duplicates, any
DistributorForm
of the same peer Ids
may be used
for a create operation.
Once a batch of DistributorForms
are submitted for
create, a CreateResponse
is returned for each
DistributorForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createDistributors(),
errors specific to an individual
DistributorForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating DistributorForm
through the
DistributorForm
Id
.
For updates, DistributorForms
are requested to the
Distributor
Id
that is to be updated using
getDistributorFormsForUpdate()
where the reference
Id
in the DistributorForm
may be used to link the
request. Similarly, the DistributorForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The DistributorForm
can only be used
once for a successful update and cannot be reused.
Once a batch of DistributorForms
are submitted for
update, an UpdateResponse
is returned for each
DistributorForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateDistributors(),
errors specific to an individual
DistributorForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating DistributorForm
through the
DistributorForm
Id.
The delete operations delete Distributors
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasDistributors(AliasRequestList aliasRequests)
Adds an
Id to a Distributor for the
purpose of creating compatibility. |
CreateResponseList |
createDistributors(DistributorBatchFormList distributorForms)
Creates a new set of
Distributors. |
DeleteResponseList |
deleteAllDistributors()
Deletes all
Distributors. |
DeleteResponseList |
deleteDistributors(IdList distributorIds)
Deletes distributors for the given
Ids. |
DistributorBatchFormList |
getDistributorFormsForCreate(long number,
Type[] distributorRecordTypes)
Gets the distributor forms for creating a bunch of new distributors.
|
DistributorBatchFormList |
getDistributorFormsForUpdate(IdList distributorIds)
Gets the distributor forms for updating an existing set of
distributors.
|
UpdateResponseList |
updateDistributors(DistributorBatchFormList distributorForms)
Updates existing distributors.
|
aliasDistributor, canCreateDistributors, canCreateDistributorWithRecordTypes, canDeleteDistributors, canManageDistributorAliases, canUpdateDistributors, createDistributor, deleteDistributor, getDistributorFormForCreate, getDistributorFormForUpdate, updateDistributor
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DistributorBatchFormList getDistributorFormsForCreate(long number, Type[] distributorRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievedistributorRecordTypes
- array of distributor record types to be
included in each create operation or an empty list if noneNullArgumentException
- distributorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createDistributors(DistributorBatchFormList distributorForms) throws OperationFailedException, PermissionDeniedException
Distributors.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.distributorForms
- the distributor formsNullArgumentException
- distributorForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorBatchFormList getDistributorFormsForUpdate(IdList distributorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
distributorIds
- the Ids
of the
Distributor
NotFoundException
- a distributorId
is
not foundNullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateDistributors(DistributorBatchFormList distributorForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.distributorForms
- the form containing the elements to be
updatedNullArgumentException
- distributorForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllDistributors() throws OperationFailedException, PermissionDeniedException
Distributors.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Ids.
distributorIds
- the Ids
of the distributors to
deleteNullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasDistributors(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Distributor
for the
purpose of creating compatibility. The primary Id
of
the Distributor
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another distributor, it is reassigned to the
given distributor Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.