Interface RepositoryBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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
• AssetContentBatchAdminSession : a session to manage asset contents in bulk
• CompositionBatchAdminSession : a session to manage compositions in bulk
• RepositoryBatchAdminSession : a session to create, modify and delete Repositories in bulk

Method Summary

Modifier and Type	Method	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.
AssetContentBatchAdminSession	getAssetContentBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk asset content administration service.
AssetContentBatchAdminSession	getAssetContentBatchAdminSessionForRepository(Id repositoryId, Proxy proxy)	Gets the OsidSession associated with the bulk asset content 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 Closeable

close

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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

Methods inherited from interface RepositoryBatchProfile

supportsAssetBatchAdmin, supportsAssetContentBatchAdmin, supportsCompositionBatchAdmin, supportsRepositoryBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsAssetBatchAdmin()	Tests if bulk administration of assets is available.
boolean	supportsAssetContentBatchAdmin()	Tests if bulk administration of asset contents is available.
boolean	supportsCompositionBatchAdmin()	Tests if bulk administration of compositions is available.
boolean	supportsRepositoryBatchAdmin()	Tests if bulk administration of repositories is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

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

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 {@code supportsAssetBatchAdmin()} is {@code 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 {@code supportsAssetBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getAssetContentBatchAdminSession

AssetContentBatchAdminSession getAssetContentBatchAdminSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the bulk asset content administration service.

Parameters:

proxy - a proxy

Returns:

an AssetContentBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentBatchAdmin() is false

Compliance:

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

getAssetContentBatchAdminSessionForRepository

AssetContentBatchAdminSession getAssetContentBatchAdminSessionForRepository(Id repositoryId,
 Proxy proxy)
                                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetContentBatchAdminSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionBatchAdmin()} is {@code 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 {@code supportsCompositionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRepositoryBatchAdmin()} is {@code true} .