org.osid.provisioning.batch

Interface ProvisioningBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, ProvisioningBatchProfile, Sourceable

public interface ProvisioningBatchManager
extends OsidManager, ProvisioningBatchProfile

The provisioning batch manager provides access to provisioning batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ProvisionBatchAdminSession: a session to create, modify and delete provisions in bulk
• QueueBatchSession: a session to create, modify and delete queues in bulk
• RequestBatchAdminSession: a session to create, modify and delete requests in bulk
• RequestBatchAdminSession: a session to create, modify and delete request transactionss in bulk
• PoolBatchAdminSession: a session to create, modify and delete pools in bulk
• ProvisionableBatchAdminSession: a session to create, modify and delete provisionables in bulk
• BrokerBatchAdminSession: a session to create, modify and delete brokers in bulk
• DistributorBatchAdminSession: a session to create, modify and delete distributors in bulk

Method Summary

Methods

Modifier and Type	Method and Description
BrokerBatchAdminSession	getBrokerBatchAdminSession() Gets the OsidSession associated with the bulk broker administration service.
BrokerBatchAdminSession	getBrokerBatchAdminSessionForDistributor(Id distributorId) Gets the OsidSession associated with the bulk broker administration service for the given distributor.
DistributorBatchAdminSession	getDistributorBatchAdminSession() Gets the OsidSession associated with the bulk distributor administration service.
PoolBatchAdminSession	getPoolBatchAdminSession() Gets the OsidSession associated with the bulk pool administration service.
PoolBatchAdminSession	getPoolBatchAdminSessionForDistributor(Id distributorId) Gets the OsidSession associated with the bulk pool administration service for the given distributor.
ProvisionableBatchAdminSession	getProvisionableBatchAdminSession() Gets the OsidSession associated with the bulk provisionable administration service.
ProvisionableBatchAdminSession	getProvisionableBatchAdminSessionForDistributor(Id distributorId) Gets the OsidSession associated with the bulk provisionable administration service for the given distributor.
ProvisionBatchAdminSession	getProvisionBatchAdminSession() Gets the OsidSession associated with the bulk provision administration service.
ProvisionBatchAdminSession	getProvisionBatchAdminSessionForDistributor(Id distributorId) Gets the OsidSession associated with the bulk provision administration service for the given distributor.
QueueBatchAdminSession	getQueueBatchAdminSession() Gets the OsidSession associated with the bulk queue administration service.
QueueBatchAdminSession	getQueueBatchAdminSessionForDistributor(Id distributorId) Gets the OsidSession associated with the bulk queue administration service for the given distributor.
RequestBatchAdminSession	getRequestBatchAdminSession() Gets the OsidSession associated with the bulk request administration service.
RequestBatchAdminSession	getRequestBatchAdminSessionForDistributor(Id distributorId) Gets the OsidSession associated with the bulk request administration service for the given distributor.
RequestTransactionBatchAdminSession	getRequestTransactionBatchAdminSession() Gets the OsidSession associated with the bulk request transaction administration service.
RequestTransactionBatchAdminSession	getRequestTransactionBatchAdminSessionForDistributor(Id distributorId) Gets the OsidSession associated with the bulk request transaction administration service for the given distributor.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.provisioning.batch.ProvisioningBatchProfile

supportsBrokerBatchAdmin, supportsDistributorBatchAdmin, supportsPoolBatchAdmin, supportsProvisionableBatchAdmin, supportsProvisionBatchAdmin, supportsQueueBatchAdmin, supportsRequestBatchAdmin, supportsRequestTransactionBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getProvisionBatchAdminSession

ProvisionBatchAdminSession getProvisionBatchAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk provision administration service.

Returns:

a ProvisionBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsProvisionBatchAdmin() is true.

getProvisionBatchAdminSessionForDistributor

ProvisionBatchAdminSession getProvisionBatchAdminSessionForDistributor(Id distributorId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the bulk provision administration service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

Returns:

a ProvisionBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionBatchAdmin() and supportsVisibleFederation() are true

getQueueBatchAdminSession

QueueBatchAdminSession getQueueBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk queue administration service.

Returns:

a QueueBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsQueueBatchAdmin() is true.

getQueueBatchAdminSessionForDistributor

QueueBatchAdminSession getQueueBatchAdminSessionForDistributor(Id distributorId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the bulk queue administration service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

Returns:

a QueueBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsQueueBatchAdmin() and supportsVisibleFederation() are true

getRequestBatchAdminSession

RequestBatchAdminSession getRequestBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk request administration service.

Returns:

a RequestBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsRequestBatchAdmin() is true.

getRequestBatchAdminSessionForDistributor

RequestBatchAdminSession getRequestBatchAdminSessionForDistributor(Id distributorId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the bulk request administration service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

Returns:

a RequestBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRequestBatchAdmin() and supportsVisibleFederation() are true

getRequestTransactionBatchAdminSession

RequestTransactionBatchAdminSession getRequestTransactionBatchAdminSession()
                                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk request transaction administration service.

Returns:

a RequestTransactionBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsRequestTransactionBatchAdmin() is true.

getRequestTransactionBatchAdminSessionForDistributor

RequestTransactionBatchAdminSession getRequestTransactionBatchAdminSessionForDistributor(Id distributorId)
                                                                                         throws NotFoundException,
                                                                                                OperationFailedException

Gets the OsidSession associated with the bulk request transaction administration service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

Returns:

a RequestTransactionBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRequestTransactionBatchAdmin() and supportsVisibleFederation() are true

getPoolBatchAdminSession

PoolBatchAdminSession getPoolBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk pool administration service.

Returns:

a PoolBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsPoolBatchAdmin() is true.

getPoolBatchAdminSessionForDistributor

PoolBatchAdminSession getPoolBatchAdminSessionForDistributor(Id distributorId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the bulk pool administration service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

Returns:

a PoolBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPoolBatchAdmin() and supportsVisibleFederation() are true

getProvisionableBatchAdminSession

ProvisionableBatchAdminSession getProvisionableBatchAdminSession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk provisionable administration service.

Returns:

a ProvisionableBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsProvisionableBatchAdmin() is true.

getProvisionableBatchAdminSessionForDistributor

ProvisionableBatchAdminSession getProvisionableBatchAdminSessionForDistributor(Id distributorId)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession associated with the bulk provisionable administration service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

Returns:

a ProvisionableBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionableBatchAdmin() and supportsVisibleFederation() are true

getBrokerBatchAdminSession

BrokerBatchAdminSession getBrokerBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk broker administration service.

Returns:

a BrokerBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsBrokerBatchAdmin() is true.

getBrokerBatchAdminSessionForDistributor

BrokerBatchAdminSession getBrokerBatchAdminSessionForDistributor(Id distributorId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the bulk broker administration service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

Returns:

a BrokerBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBrokerBatchAdmin() and supportsVisibleFederation() are true

getDistributorBatchAdminSession

DistributorBatchAdminSession getDistributorBatchAdminSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk distributor administration service.

Returns:

a DistributorBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsDistributorBatchAdmin() is true.