## Uses of Interface
cdac.medinfo.sdk.hl7282.hl7net.commons.IHL7BatchFile

- Packages that use IHL7BatchFile
  Package | Description
  --- | ---
  cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.batch | Provides classes for Batch, BatchFile and BatchAgent used for Batch Protocol.
  cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.transactionhandler | Provides classes which interact with application layer layer.
  cdac.medinfo.sdk.hl7282.hl7net.commons | Provides Interfaces which are required to be implemented by Session classes, Network Agents & MessageAgents of Client Server.
  cdac.medinfo.sdk.hl7282.hl7net.communication | Provides classes which are required for Message buffer parsing from network stream.
  cdac.medinfo.sdk.hl7282.hl7net.upperlayer | Provides classes which interact with application layer and base network layer.

- - ### Uses of IHL7BatchFile in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.batch

    Classes in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.batch that implement IHL7BatchFile
    Modifier and Type | Class and Description
    --- | ---
    `class` | `HL7BatchFile` HL7BatchFile consist of BatchFile header, trailer, and Collection of batches .

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.batch that return IHL7BatchFile
    Modifier and Type | Method and Description
    --- | ---
    `IHL7BatchFile` | BatchAgent.`createBatchFile(MessageFactory objMessageFactory, ISegmentSet objSegmentSet)` Creates HL7BatchFile and populate it through provided SegmentSet.
    `IHL7BatchFile` | BatchAgent.`populateBatchFile(MessageFactory objMessageFactory, ISegmentSet objSegmentSet)` Populates HL7BatchFile through provided SegmentSet.
    `IHL7BatchFile` | BatchAgent.`processReceive(MessageFactory objMessageFactory, ISegmentSet objISegmentSet)` Retrieves populated HL7BatchFile through given SegmentSet.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.batch with parameters of type IHL7BatchFile
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | BatchAgent.`getSegmentSet(IHL7BatchFile objHL7BatchFile)` Populates SegemntSet through provided HL7BatchFile.
    `ISegmentSet` | BatchAgent.`processSend(IHL7BatchFile objHL7BatchFile)` Retrieves SegmentSet generated through provided HL7BatchFile.

  - ### Uses of IHL7BatchFile in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.transactionhandler

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.transactionhandler with parameters of type IHL7BatchFile
    Modifier and Type | Method and Description
    --- | ---
    `void` | TransactionHandler.`processBatchTransaction(IHL7BatchFile objHL7BatchFile)` Processes the batchfile and verified each batch in it.

  - ### Uses of IHL7BatchFile in cdac.medinfo.sdk.hl7282.hl7net.commons

    Methods in cdac.medinfo.sdk.hl7282.hl7net.commons that return IHL7BatchFile
    Modifier and Type | Method and Description
    --- | ---
    `IHL7BatchFile` | IBatchProcessor.`createBatchFile(MessageFactory objMessageFactory, ISegmentSet objSegmentSet)` Creates HL7BatchFile and populate it through provided SegmentSet.
    `IHL7BatchFile` | IBatchProcessor.`populateBatchFile(MessageFactory objMessageFactory, ISegmentSet objSegmentSet)` Populates HL7BatchFile through provided SegmentSet.
    `IHL7BatchFile` | IBatchProcessor.`processReceive(MessageFactory objMessageFactory, ISegmentSet objSegmentSet)` Retrieves populated HL7BatchFile through given SegmentSet.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.commons with parameters of type IHL7BatchFile
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | IBatchProcessor.`getSegmentSet(IHL7BatchFile objHL7BatchFile)` Populates SegemntSet through provided HL7BatchFile.
    `void` | IDataNotificationListener.`notifyData(IHL7BatchFile objBatchFile)` Adds Data Notification Listeners to Receive HL7BatchFile.
    `void` | ITransactionHandler.`processBatchTransaction(IHL7BatchFile objHL7BatchFile)` Processes the batch or batch file and verified each batch inside it.
    `ISegmentSet` | IBatchProcessor.`processSend(IHL7BatchFile objHL7BatchFile)` Retrieves SegmentSet generated through provided HL7BatchFile.

  - ### Uses of IHL7BatchFile in cdac.medinfo.sdk.hl7282.hl7net.communication

    Methods in cdac.medinfo.sdk.hl7282.hl7net.communication with parameters of type IHL7BatchFile
    Modifier and Type | Method and Description
    --- | ---
    `void` | ServerSideMessageAgent.`sendBatch(IHL7BatchFile objBatchFileToSend)` Gets automatically invoked when Batch is received from remote system.
    `void` | ClientSideMessageAgent.`sendBatch(IHL7BatchFile objHl7BatchFile)` Gets automatically invoked when Batch is received from remote system.

  - ### Uses of IHL7BatchFile in cdac.medinfo.sdk.hl7282.hl7net.upperlayer

    Methods in cdac.medinfo.sdk.hl7282.hl7net.upperlayer that return IHL7BatchFile
    Modifier and Type | Method and Description
    --- | ---
    `IHL7BatchFile` | ClientSession.`getBatchFile()` Retrieves HL7BatchFile from ClientSession

    Methods in cdac.medinfo.sdk.hl7282.hl7net.upperlayer that return types with arguments of type IHL7BatchFile
    Modifier and Type | Method and Description
    --- | ---
    `ISingleCollection<IHL7BatchFile>` | UserSession.`getResponseBatches()` Retrieves last received Response Batch collection.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.upperlayer with parameters of type IHL7BatchFile
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserSession.`notifyData(IHL7BatchFile objBatchFile)` Invoked when HL7BatchFile is received from Remote End.
    `void` | ClientSession.`notifyData(IHL7BatchFile objHL7BatchFile)` Invoked when HL7BatchFile is received from Remote end.
    `void` | IBatchReceiver.`onBatchReceive(IHL7BatchFile objHL7BatchFile)` Method received HL7BatchFile .
    `boolean` | ClientSession.`sendBatch(IHL7BatchFile objHL7BatchFile)` Sends specified Batch to Network Agent.
    `boolean` | UserSession.`sendBatchFile(IHL7BatchFile objBatchFile)` Sends specified HL7BatchFile server system if Batch processor is supported.