Interface ProvisioningBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface ProvisioningBatchProfile

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

Modifier and Type	Method	Description
boolean	supportsBrokerBatchAdmin()	Tests if bulk administration of brokers is available.
boolean	supportsDistributorBatchAdmin()	Tests if bulk administration of distributors is available.
boolean	supportsPoolBatchAdmin()	Tests if bulk administration of pools is available.
boolean	supportsProvisionableBatchAdmin()	Tests if bulk administration of provisionables is available.
boolean	supportsProvisionBatchAdmin()	Tests if bulk administration of provisions is available.
boolean	supportsQueueBatchAdmin()	Tests if bulk administration of queues is available.
boolean	supportsRequestBatchAdmin()	Tests if bulk administration of requests is available.
boolean	supportsRequestTransactionBatchAdmin()	Tests if bulk administration of requests is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsProvisionBatchAdmin()} is {@code 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 {@code supportsProvisionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsQueueBatchAdmin()} is {@code 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 {@code supportsQueueBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRequestBatchAdmin()} is {@code 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 {@code supportsRequestBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRequestTransactionBatchAdmin()} is {@code 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 {@code supportsRequestTransactionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPoolBatchAdmin()} is {@code 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 {@code supportsPoolBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProvisionableBatchAdmin()} is {@code 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 {@code supportsProvisionableBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBrokerBatchAdmin()} is {@code 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 {@code supportsBrokerBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDistributorBatchAdmin()} is {@code true} .