org.osid.installation.batch

Interface InstallationBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, InstallationBatchProfile, 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:

• 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() Gets the OsidSession associated with the bulk depot administration service.
PackageBatchAdminSession	getPackageBatchAdminSession() Gets the OsidSession associated with the bulk package administration service.
PackageBatchAdminSession	getPackageBatchAdminSessionForDepot(Id depotId) Gets the OsidSession associated with the bulk package administration service for the given depot.

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

Gets the OsidSession associated with the bulk package administration service.

Returns:

a PackageBatchAdminSession

Throws:

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)
                                                             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 PackageBatchAdminSession

Throws:

NotFoundException - no Depot found by the given Id

NullArgumentException - depotId 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()
                                                 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 supportsDepotBatchAdmin() is true.