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:

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

Method Summary

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

close

Methods inherited from interface InstallationBatchProfile

supportsDepotBatchAdmin, supportsPackageBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsDepotBatchAdmin()	Tests if bulk administration of depots is available.
boolean	supportsPackageBatchAdmin()	Tests if bulk administration of packages is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

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

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

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

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

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 {@code supportsPackageBatchAdmin()} is {@code 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 {@code supportsPackageBatchAdmin()} 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} .