Interface OfferingBatchManager

All Superinterfaces:
AutoCloseable, Closeable, OfferingBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface OfferingBatchManager extends OsidManager, OfferingBatchProfile

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

  • CanonicalUnitBatchAdminSession : a session to create, modify and delete canonical units in bulk
  • OfferingBatchAdminSession : a session to create, modify and delete offerings in bulk
  • ParticipantBatchSession : a session to create, modify and delete participants in bulk
  • ResultBatchAdminSession : a session to create, modify and delete results in bulk
  • CatalogueBatchAdminSession : a session to create, modify and delete catalogues in bulk

  • Method Details

    • getCanonicalUnitBatchAdminSession

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

    • getCanonicalUnitBatchAdminSessionForCatalogue

      CanonicalUnitBatchAdminSession getCanonicalUnitBatchAdminSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk canonical unit administration service for the given catalogue
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitBatchAdminSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getOfferingBatchAdminSession

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

    • getOfferingBatchAdminSessionForCatalogue

      OfferingBatchAdminSession getOfferingBatchAdminSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk offering administration service for the given catalogue
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingBatchAdminSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getParticipantBatchAdminSession

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

    • getParticipantBatchAdminSessionForCatalogue

      ParticipantBatchAdminSession getParticipantBatchAdminSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk participant administration service for the given catalogue
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a ParticipantBatchAdminSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParticipantBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParticipantBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getResultBatchAdminSession

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

    • getResultBatchAdminSessionForCatalogue

      ResultBatchAdminSession getResultBatchAdminSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk result administration service for the given catalogue
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a ResultBatchAdminSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsResultBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResultBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getCatalogueBatchAdminSession

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