org.osid.installation.batch

Interface InstallationBatchProxyManager

All Superinterfaces:

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

public interface InstallationBatchProxyManager
extends OsidProxyManager, InstallationBatchProfile

The installation batch proxy manager provides access to installation 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:

• PackageBatchAdminSession: a session to create, modify and delete packages in bulk
• DepotBatchAdminSession: a session to create, modify and delete depots in bulk

Method Summary

Methods

Modifier and Type	Method and Description
DepotBatchAdminSession	getDepotBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk depot administration service.
PackageBatchAdminSession	getPackageBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk package administration service.
PackageBatchAdminSession	getPackageBatchAdminSessionForDepot(Id depotId, Proxy proxy) Gets the OsidSession associated with the bulk package administration service for the given depot.

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.installation.batch.InstallationBatchProfile

supportsDepotBatchAdmin, supportsPackageBatchAdmin, 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

getPackageBatchAdminSession

PackageBatchAdminSession getPackageBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk package administration service.

Parameters:

proxy - a proxy

Returns:

a PackageBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageBatchAdmin() is false

Compliance:

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

getPackageBatchAdminSessionForDepot

PackageBatchAdminSession getPackageBatchAdminSessionForDepot(Id depotId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the bulk package administration service for the given depot.

Parameters:

depotId - the Id of the Depot

proxy - a proxy

Returns:

a PackageBatchAdminSession

Throws:

NotFoundException - no Depot found by the given Id

NullArgumentException - depotId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getDepotBatchAdminSession

DepotBatchAdminSession getDepotBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk depot administration service.

Parameters:

proxy - a proxy

Returns:

a DepotBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDepotBatchAdmin() is false

Compliance:

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