org.osid.provisioning.batch

Interface ProvisioningBatchProxyManager

All Superinterfaces:

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

public interface ProvisioningBatchProxyManager
extends OsidProxyManager, ProvisioningBatchProfile

The provisioning batch proxy manager provides access to provisioning batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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
• RequestTransactionBatchAdminSession: a session to create, modify and delete request transactions 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(Proxy proxy) Gets the OsidSession associated with the bulk broker administration service.
BrokerBatchAdminSession	getBrokerBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the bulk broker administration service for the given distributor.
DistributorBatchAdminSession	getDistributorBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk distributor administration service.
PoolBatchAdminSession	getPoolBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk pool administration service.
PoolBatchAdminSession	getPoolBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the bulk pool administration service for the given distributor.
ProvisionableBatchAdminSession	getProvisionableBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk provisionable administration service.
ProvisionableBatchAdminSession	getProvisionableBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the bulk provisionable administration service for the given distributor.
ProvisionBatchAdminSession	getProvisionBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk provision administration service.
ProvisionBatchAdminSession	getProvisionBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the bulk provision administration service for the given distributor.
QueueBatchAdminSession	getQueueBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk queue administration service.
QueueBatchAdminSession	getQueueBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the bulk queue administration service for the given distributor.
RequestBatchAdminSession	getRequestBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk request administration service.
RequestBatchAdminSession	getRequestBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the bulk request administration service for the given distributor.
RequestTransactionBatchAdminSession	getRequestTransactionBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk request transaction administration service.
RequestTransactionBatchAdminSession	getRequestTransactionBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the bulk request transaction administration service for the given distributor.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk provision administration service.

Parameters:

proxy - a proxy

Returns:

a ProvisionBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk queue administration service.

Parameters:

proxy - a proxy

Returns:

a QueueBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a QueueBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk request administration service.

Parameters:

proxy - a proxy

Returns:

a RequestBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy 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(Proxy proxy)
                                                                           throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a RequestTransactionBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                       Proxy proxy)
                                                                                         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

proxy - a proxy

Returns:

a RequestTransactionBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk pool administration service.

Parameters:

proxy - a proxy

Returns:

a PoolBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy 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(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk provisionable administration service.

Parameters:

proxy - a proxy

Returns:

a ProvisionableBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionableBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk broker administration service.

Parameters:

proxy - a proxy

Returns:

a BrokerBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerBatchAdminSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy 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(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk distributor administration service.

Parameters:

proxy - a proxy

Returns:

a DistributorBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorBatchAdmin() is false

Compliance:

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