Interface HoldBatchManager

All Superinterfaces:
AutoCloseable, Closeable, HoldBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface HoldBatchManager extends OsidManager, HoldBatchProfile

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

  • BlockBatchAdminSession : a session to create, modify and delete blocks in bulk
  • IssueBatchSession : a session to create, modify and delete issues in bulk
  • HoldBatchAdminSession : a session to create, modify and delete holds in bulk
  • OublietteBatchAdminSession : a session to create, modify and delete oubliettes in bulk

  • Method Details

    • getBlockBatchAdminSession

      BlockBatchAdminSession getBlockBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk block administration service.
      Returns:
      a BlockBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBlockBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBlockBatchAdmin()} is {@code true} .

    • getBlockBatchAdminSessionForOubliette

      BlockBatchAdminSession getBlockBatchAdminSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk block administration service for the given oubliette.
      Parameters:
      oublietteId - the Id of the Oubliette
      Returns:
      a BlockBatchAdminSession
      Throws:
      NotFoundException - no Oubliette found by the given Id
      NullArgumentException - oublietteId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBlockBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBlockBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getIssueBatchAdminSession

      IssueBatchAdminSession getIssueBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk issue administration service.
      Returns:
      an IssueBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsIssueBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsIssueBatchAdmin()} is {@code true} .

    • getIssueBatchAdminSessionForOubliette

      IssueBatchAdminSession getIssueBatchAdminSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk issue administration service for the given oubliette.
      Parameters:
      oublietteId - the Id of the Oubliette
      Returns:
      an IssueBatchAdminSession
      Throws:
      NotFoundException - no Oubliette found by the given Id
      NullArgumentException - oublietteId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsIssueBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsIssueBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getHoldBatchAdminSession

      HoldBatchAdminSession getHoldBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk hold administration service.
      Returns:
      a HoldBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsHoldBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsHoldBatchAdmin()} is {@code true} .

    • getHoldBatchAdminSessionForOubliette

      HoldBatchAdminSession getHoldBatchAdminSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk hold administration service for the given oubliette.
      Parameters:
      oublietteId - the Id of the Oubliette
      Returns:
      a HoldBatchAdminSession
      Throws:
      NotFoundException - no Oubliette found by the given Id
      NullArgumentException - oublietteId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsHoldBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsHoldBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getOublietteBatchAdminSession

      OublietteBatchAdminSession getOublietteBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk oubliette administration service.
      Returns:
      an OublietteBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOublietteBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOublietteBatchAdmin()} is {@code true} .