public interface PoolBatchAdminSession extends PoolAdminSession
This session creates, updates, and deletes Pools
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
Pool,
a PoolForm
is requested using
getPoolFormsForCreate()
specifying the desired broker and record
Types
or none if no record Types
are needed.
Each of the returned PoolForms
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 PoolForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
PoolForm
corresponds to an attempted transaction.
The PoolForms
returned from
getPoolFormsForCreate()
may be linked to the originating request
through the peer Ids
of the PoolForm.
In the
case where there may be duplicates, any PoolForm
of the
same peer Ids
may be used for a create operation.
Once a batch of PoolForms
are submitted for create, a
CreateResponse
is returned for each PoolForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createPools(),
errors specific to an individual PoolForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating PoolForm
through the PoolForm
Id
.
For updates, PoolForms
are requested to the Pool
Id
that is to be updated using
getPoolFormsForUpdate()
where the reference Id
in
the PoolForm
may be used to link the request. Similarly,
the PoolForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
PoolForm
can only be used once for a successful update and
cannot be reused.
Once a batch of PoolForms
are submitted for update, an
UpdateResponse
is returned for each PoolForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updatePools(),
errors specific to an individual PoolForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating PoolForm
through the PoolForm
Id.
The delete operations delete Pools
in bulk. To unmap a
Pool
from the current Distributor,
the
PoolDistributorAssignmentSession
should be used. These
delete operations attempt to remove the Pool
itself thus
removing it from all known Distributor
catalogs. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasPools(AliasRequestList aliasRequests)
Adds an
Id to a Pool for the purpose of
creating compatibility. |
CreateResponseList |
createPools(PoolBatchFormList poolForms)
Creates a new set of
Pools. |
DeleteResponseList |
deleteAllPools()
Deletes all
Pools in this Distributor . |
DeleteResponseList |
deletePools(IdList poolIds)
Deletes pools for the given
Ids. |
DeleteResponseList |
deletePoolsForBroker(Id brokerId)
Deletes pools for the given broker.
|
PoolBatchFormList |
getPoolFormsForCreate(IdList brokerIdList,
Type[] poolRecordTypes)
Gets the pool forms for creating a bunch of new pools.
|
PoolBatchFormList |
getPoolFormsForUpdate(IdList poolIds)
Gets the pool forms for updating an existing set of pools.
|
UpdateResponseList |
updatePools(PoolBatchFormList poolForms)
Updates existing pools.
|
aliasPool, canCreatePools, canCreatePoolWithRecordTypes, canDeletePools, canManagePoolAliases, canUpdatePools, createPool, deletePool, getDistributor, getDistributorId, getPoolFormForCreate, getPoolFormForUpdate, updatePool
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PoolBatchFormList getPoolFormsForCreate(IdList brokerIdList, Type[] poolRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolForm
is returned for each broker Id.
brokerIdList
- a list of broker Ids
poolRecordTypes
- array of pool record types to be included in
each create operation or an empty list if noneNotFoundException
- a brokerId
is not
foundNullArgumentException
- brokerIds
or
poolRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createPools(PoolBatchFormList poolForms) throws OperationFailedException, PermissionDeniedException
Pools.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.poolForms
- the pool formsNullArgumentException
- poolForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolBatchFormList getPoolFormsForUpdate(IdList poolIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolIds
- the Ids
of the Pool
NotFoundException
- a poolId
is not
foundNullArgumentException
- poolIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updatePools(PoolBatchFormList poolForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.poolForms
- the form containing the elements to be updatedNullArgumentException
- poolForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllPools() throws OperationFailedException, PermissionDeniedException
Pools
in this Distributor
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deletePools(IdList poolIds) throws OperationFailedException, PermissionDeniedException
Ids.
poolIds
- the Ids
of the pools to deleteNullArgumentException
- poolIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deletePoolsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
brokerId
- the Id
of a brokerNullArgumentException
- brokerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasPools(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Pool
for the purpose of
creating compatibility. The primary Id
of the
Pool
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another pool, it is reassigned to the given pool Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.