Interface RepositoryBatchManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, 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
  • AssetContentBatchAdminSession : a session to create, modify and delete AssetContents 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 Details

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

    • getAssetContentBatchAdminSession

      AssetContentBatchAdminSession getAssetContentBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk asset content administration service.
      Returns:
      an AssetContentBatchAdminSession
      Throws:
      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) 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
      Returns:
      an AssetContentBatchAdminSession
      Throws:
      NotFoundException - no Repository found by the given Id
      NullArgumentException - repositoryId 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() 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 {@code supportsCompositionBatchAdmin()} is {@code 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 {@code supportsCompositionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRepositoryBatchAdmin()} is {@code true} .