Interface InstallationBatchManager

All Superinterfaces:

AutoCloseable, Closeable, InstallationBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface InstallationBatchManager
extends OsidManager, InstallationBatchProfile

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

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

InstallationBatchManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
DepotBatchAdminSession	getDepotBatchAdminSession()	Gets the OsidSession associated with the bulk depot administration service.
InstallationPackageBatchAdminSession	getInstallationPackageBatchAdminSession()	Gets the OsidSession associated with the bulk package administration service.
InstallationPackageBatchAdminSession	getInstallationPackageBatchAdminSessionForDepot(Id depotId)	Gets the OsidSession associated with the bulk package administration service for the given depot.

Methods inherited from interface Closeable

close

Methods inherited from interface InstallationBatchProfile

supportsDepotBatchAdmin, supportsInstallationPackageBatchAdmin, supportsVisibleFederation

Methods inherited from interface OsidManager

close

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface OsidProfile

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

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getInstallationPackageBatchAdminSession

InstallationPackageBatchAdminSession getInstallationPackageBatchAdminSession()
                                                                      throws OperationFailedException

Gets the OsidSession associated with the bulk package administration service.

Returns:

a InstallationPackageBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationPackageBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsInstallationPackageBatchAdmin()} is {@code true}.

getInstallationPackageBatchAdminSessionForDepot

InstallationPackageBatchAdminSession getInstallationPackageBatchAdminSessionForDepot(Id depotId)
                                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

depotId - the Id of the Depot

Returns:

a InstallationPackageBatchAdminSession

Throws:

NotFoundException - no Depot found by the given Id

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationPackageBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsInstallationPackageBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getDepotBatchAdminSession

DepotBatchAdminSession getDepotBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk depot administration service.

Returns:

a DepotBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDepotBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDepotBatchAdmin()} is {@code true}.