org.osid.repository.batch

Interface RepositoryBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RepositoryBatchProfile, Sourceable

public interface RepositoryBatchManager
extends OsidManager, RepositoryBatchProfile

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

• AssetBatchAdminSession: a session to create, modify and delete Assets in bulk
• CompositionBatchAdminSession: a session to create, modify and delete Compositions in bulk
• RepositoryBatchAdminSession: a session to create, modify and delete Repositories in bulk

Method Summary

Methods

Modifier and Type	Method and Description
AssetBatchAdminSession	getAssetBatchAdminSession() Gets the OsidSession associated with the bulk asset administration service.
AssetBatchAdminSession	getAssetBatchAdminSessionForRepository(Id repositoryId) Gets the OsidSession associated with the bulk asset administration service for the given repository.
CompositionBatchAdminSession	getCompositionBatchAdminSession() Gets the OsidSession associated with the bulk composition administration service.
CompositionBatchAdminSession	getCompositionBatchAdminSessionForRepository(Id repositoryId) Gets the OsidSession associated with the bulk composition administration service for the given repository.
RepositoryBatchAdminSession	getRepositoryBatchAdminSession() Gets the OsidSession associated with the bulk repository administration service.

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.repository.batch.RepositoryBatchProfile

supportsAssetBatchAdmin, supportsCompositionBatchAdmin, supportsRepositoryBatchAdmin, 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

getAssetBatchAdminSession

AssetBatchAdminSession getAssetBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk asset administration service.

Returns:

an AssetBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetBatchAdmin() is false

Compliance:

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

getAssetBatchAdminSessionForRepository

AssetBatchAdminSession getAssetBatchAdminSessionForRepository(Id repositoryId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the bulk asset administration service for the given repository.

Parameters:

repositoryId - the Id of the Repository

Returns:

an AssetBatchAdminSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCompositionBatchAdminSession

CompositionBatchAdminSession getCompositionBatchAdminSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk composition administration service.

Returns:

a CompositionBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionBatchAdmin() is false

Compliance:

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

getCompositionBatchAdminSessionForRepository

CompositionBatchAdminSession getCompositionBatchAdminSessionForRepository(Id repositoryId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the bulk composition administration service for the given repository.

Parameters:

repositoryId - the Id of the Repository

Returns:

a CompositionBatchAdminSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRepositoryBatchAdminSession

RepositoryBatchAdminSession getRepositoryBatchAdminSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk repository administration service.

Returns:

a RepositoryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryBatchAdmin() is false

Compliance:

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