org.osid.provisioning.batch

Interface PoolBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PoolAdminSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.provisioning.PoolAdminSession

aliasPool, canCreatePools, canCreatePoolWithRecordTypes, canDeletePools, canManagePoolAliases, canUpdatePools, createPool, deletePool, getDistributor, getDistributorId, getPoolFormForCreate, getPoolFormForUpdate, updatePool

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPoolFormsForCreate

PoolBatchFormList getPoolFormsForCreate(IdList brokerIdList,
                                      Type[] poolRecordTypes)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the pool forms for creating a bunch of new pools. A PoolForm is returned for each broker Id.

Parameters:

brokerIdList - a list of broker Ids

poolRecordTypes - array of pool record types to be included in each create operation or an empty list if none

Returns:

the pool forms

Throws:

NotFoundException - a brokerId is not found

NullArgumentException - brokerIds or poolRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createPools

CreateResponseList createPools(PoolBatchFormList poolForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

Creates a new set of Pools. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

poolForms - the pool forms

Returns:

the create responses

Throws:

NullArgumentException - poolForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolFormsForUpdate

PoolBatchFormList getPoolFormsForUpdate(IdList poolIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the pool forms for updating an existing set of pools. A new pool form should be requested for each update transaction.

Parameters:

poolIds - the Ids of the Pool

Returns:

the pool form

Throws:

NotFoundException - a poolId is not found

NullArgumentException - poolIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePools

UpdateResponseList updatePools(PoolBatchFormList poolForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

Updates existing pools. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

poolForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - poolForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPools

DeleteResponseList deleteAllPools()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes all Pools in this Distributor .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePools

DeleteResponseList deletePools(IdList poolIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes pools for the given Ids.

Parameters:

poolIds - the Ids of the pools to delete

Returns:

the delete responses

Throws:

NullArgumentException - poolIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePoolsForBroker

DeleteResponseList deletePoolsForBroker(Id brokerId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes pools for the given broker.

Parameters:

brokerId - the Id of a broker

Returns:

the delete responses

Throws:

NullArgumentException - brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPools

AliasResponseList aliasPools(AliasRequestList aliasRequests)
                             throws OperationFailedException,
                                    PermissionDeniedException

Adds an 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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.