org.osid.repository.batch

Interface RepositoryBatchProxyManager

All Superinterfaces:

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

public interface RepositoryBatchProxyManager
extends OsidProxyManager, RepositoryBatchProfile

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

• AssetBatchAdminSession: a session to manage assets in bulk
• CompositionBatchAdminSession: a session to manage 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(Proxy proxy) Gets the OsidSession associated with the bulk asset administration service.
AssetBatchAdminSession	getAssetBatchAdminSessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the bulk asset administration service for the given repository.
CompositionBatchAdminSession	getCompositionBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk composition administration service.
CompositionBatchAdminSession	getCompositionBatchAdminSessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the bulk composition administration service for the given repository.
RepositoryBatchAdminSession	getRepositoryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk repository administration service.

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

Gets the OsidSession associated with the bulk asset administration service.

Parameters:

proxy - a proxy

Returns:

an AssetBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetBatchAdminSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk composition administration service.

Parameters:

proxy - a proxy

Returns:

a CompositionBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

a CompositionBatchAdminSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk repository administration service.

Parameters:

proxy - a proxy

Returns:

a RepositoryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryBatchAdmin() is false

Compliance:

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