## Uses of Interface
cdac.medinfo.sdk.hl7282.commoninterface.ISegmentSet

- Packages that use ISegmentSet
  Package | Description
  --- | ---
  cdac.medinfo.sdk.hl7282.baselibs.messages | Provides Classes necessary to create Message, Acknowledgement and also contains Exception classes which are specific to message operations like serialize, validate & parse.
  cdac.medinfo.sdk.hl7282.baselibs.parserserializer | Provides Classes necessary to parse and serialize the HL7 Message.
  cdac.medinfo.sdk.hl7282.baselibs.segments | Provides classes which implement segments in HL7 standard.
  cdac.medinfo.sdk.hl7282.commoninterface | Defines contract for base library and HL7 model.
  cdac.medinfo.sdk.hl7282.hl7model.messages.observationreporting | Provides classes which implement Observation Reporting Messages.
  cdac.medinfo.sdk.hl7282.hl7model.messages.orderentry | Provides classes which implement Order Entry Messages.
  cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.batch | Provides classes for Batch, BatchFile and BatchAgent used for Batch Protocol.
  cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.interactivecontinuation | Provides classes which interact with application layer and base network layer.
  cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.pubsub | Provides classes which are responsible for the Publish - Subscribe Communication.
  cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.querycancel | Provides classes which interact with application layer and base network layer.
  cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.sequence | Provides classes which are responsible for the Sequencing in the Messages.
  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 ISegmentSet in cdac.medinfo.sdk.hl7282.baselibs.messages

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messages that return ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | Message.`getSegmentSet()` Retrieves populated SegmentSet from message structure.
    `ISegmentSet` | Group.`getSegmentSet()` Retrieves all segments present in this group

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messages with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `int` | Message.`populate(ISegmentSet objSegmentSet)` Populates Message using provided SegmentSet according to Message Structure specified by HL7 standard.
    `int` | Group.`populate(ISegmentSet objSegmentSet)` Populates the Segment Set.
    `Message` | Message_Source_Recepient.`populateMessage(EnumMessageCode enumMessageCode, EnumTriggerEvent enumTriggerEvent, ISegmentSet objISegmentSet)` Populates Message with Specified Message Structure & Message Trigger Event from SegmentSet.
    `Message` | IMessageSource.`populateMessage(EnumMessageCode enumMessageCode, EnumTriggerEvent enumTriggerEvent, ISegmentSet objISegmentSet)` Parses Message with Specified Message Structure & Message Trigger Event from HL7 Stream.
    `Message` | IMessageRecepient.`populateMessage(EnumMessageCode enumMessageCode, EnumTriggerEvent enumTriggerEvent, ISegmentSet objISegmentSet)` Parses Message with Specified Message Structure & Message Trigger Event from HL7 Stream.
    `Message` | Message_Source_Recepient.`populateMessage(ISegmentSet objISegmentSet)` Populates Message from HL7 Stream.
    `Message` | LocalExtensionAgent.`populateMessage(ISegmentSet objSegmentSet)` Populates a locally extended message.
    `Message` | IMessageSource.`populateMessage(ISegmentSet objISegmentSet)` Parses Message from HL7 Stream.
    `Message` | IMessageRecepient.`populateMessage(ISegmentSet objISegmentSet)` Parses Message from HL7 Stream.
    `Message` | LocalExtensionAgent.`populateMessage(java.lang.String strMessageCode, java.lang.String strTriggerEvent, ISegmentSet objSegmentSet)` Populates a locally extended message with provided message code and trigger event.
    `Message` | MessageFactory.`populateReceiveSupportedMessage(java.lang.String strMessageCode, java.lang.String strTriggerEvent, ISegmentSet objISegmentSet)` Populates instance of message using provided SegmentSet.

  - ### Uses of ISegmentSet in cdac.medinfo.sdk.hl7282.baselibs.parserserializer

    Methods in cdac.medinfo.sdk.hl7282.baselibs.parserserializer that return ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | HL7Parser.`parse(IHL7Stream objHL7Stream)` Parses the HL7Stream which contains a HL7 Message and populates the SegmentSet accordingly.
    `ISegmentSet` | HL7Parser.`parse(java.lang.String strFilePath)` Parses the HL7 Message from given file and populates the SegmentSet accordingly.

    Methods in cdac.medinfo.sdk.hl7282.baselibs.parserserializer with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | HL7Serializer.`serialize(ISegmentSet objSegmentSet, IHL7Stream objHL7Stream)` Serializes the SegmentSet on given stream.
    `boolean` | HL7Serializer.`serialize(ISegmentSet objSegmentSet, java.lang.String strFilePath)` Serializes the SegmentSet on given file location.

  - ### Uses of ISegmentSet in cdac.medinfo.sdk.hl7282.baselibs.segments

    Classes in cdac.medinfo.sdk.hl7282.baselibs.segments that implement ISegmentSet
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SegmentSet` SegmentSet represents a list of Segments.

  - ### Uses of ISegmentSet in cdac.medinfo.sdk.hl7282.commoninterface

    Methods in cdac.medinfo.sdk.hl7282.commoninterface that return ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | IGroup.`getSegmentSet()` Retrieves all segments present in this group

    Methods in cdac.medinfo.sdk.hl7282.commoninterface with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `int` | IGroup.`populate(ISegmentSet objSegmentSet)` Populates the Segment Set.

  - ### Uses of ISegmentSet in cdac.medinfo.sdk.hl7282.hl7model.messages.observationreporting

    Methods in cdac.medinfo.sdk.hl7282.hl7model.messages.observationreporting with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `int` | OUL_R24.`populate(ISegmentSet objSegmentSet)` Populates Message using provided SegmentSet according to Message Structure specified by HL7 standard.
    `int` | CSU_C09_Common.`populate(ISegmentSet objSegmentSet)` Populates Message using provided SegmentSet according to Message Structure specified by HL7 standard.

  - ### Uses of ISegmentSet in cdac.medinfo.sdk.hl7282.hl7model.messages.orderentry

    Methods in cdac.medinfo.sdk.hl7282.hl7model.messages.orderentry with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `int` | ORD_O04.`populate(ISegmentSet objSegmentSet)` Populates Message using provided SegmentSet according to Message Structure specified by HL7 standard.
    `int` | OMD_O03.`populate(ISegmentSet objSegmentSet)` Populates Message using provided SegmentSet according to Message Structure specified by HL7 standard.

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

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.batch that return ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | BatchAgent.`getSegmentSet(IHL7Batch objBatch)` Populates SegemntSet through provided HL7Batch.
    `ISegmentSet` | BatchAgent.`getSegmentSet(IHL7BatchFile objHL7BatchFile)` Populates SegemntSet through provided HL7BatchFile.
    `ISegmentSet` | BatchAgent.`processSend(IHL7BatchFile objHL7BatchFile)` Retrieves SegmentSet generated through provided HL7BatchFile.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.batch with parameters of type ISegmentSet
    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.

  - ### Uses of ISegmentSet in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.interactivecontinuation

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.interactivecontinuation that return ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | ClientSideQICAgent.`generateCancellationQuery(java.lang.String strQueryId)`
    `ISegmentSet` | ClientSideQICAgent.`generateInteractiveQuery(java.lang.String strQueryId)` Retrieves the number of query fired for specified Query ID.
    `ISegmentSet` | ServerSideQICAgent.`generateInteractiveResponse(java.lang.String strQueryId)` Retrieves the number of query fired for specified Query ID.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.interactivecontinuation with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | ServerSideQICAgent.`processReceive(ISegmentSet objSegmentSet)` Keeps the logs of incoming Interactive Queries.
    `boolean` | ClientSideQICAgent.`processReceive(ISegmentSet objSegmentSet)` Keeps the logs of incoming Interactive Responses.
    `void` | ServerSideQICAgent.`processSend(ISegmentSet objSegmentSet)` Keeps the logs of outgoing Interactive Responses.
    `void` | ClientSideQICAgent.`processSend(ISegmentSet objSegmentSet)` Keeps the logs of outgoing Interactive Queries.

  - ### Uses of ISegmentSet in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.pubsub

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.pubsub with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `EnumSubscriptionType` | PublishAgent.`getSubscriptionType(ISegmentSet objSegmentSet)` This will check that recieved message is subscription message or not.

  - ### Uses of ISegmentSet in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.querycancel

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.querycancel that return ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | ClientSideQCNAgent.`generateCancellationQuery(java.lang.String strQueryId)` This method will generate segment set for QCN^J01.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.querycancel that return types with arguments of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISingleCollection<ISegmentSet>` | ClientSideQCNAgent.`getCancelledMessages()` This method returns the Collection of Segment Set which are canceled by user.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.querycancel with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | ServerSideQCNAgent.`processReceive(ISegmentSet objSegmentSet)` This method will keep track for all responses which are received at Server Side.
    `boolean` | ClientSideQCNAgent.`processReceive(ISegmentSet objSegmentSet)` This method keeps track for the Responses received.
    `boolean` | ServerSideQCNAgent.`processSend(ISegmentSet objSegmentSet)` This method keeps track for the queries which are send by Sever.
    `boolean` | ClientSideQCNAgent.`processSend(ISegmentSet objSegmentSet)` This method will process the sending queries by client.

  - ### Uses of ISegmentSet in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.sequence

    Methods in cdac.medinfo.sdk.hl7282.hl7net.auxiliaryprotocol.sequence with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `void` | ReceivingSequenceAgent.`processReceive(ISegmentSet objSegmentSet)` Invoked when system receive message.
    `void` | InitiatingSequenceAgent.`processReceive(ISegmentSet objSegmentSet)` Invoked when system receive message.
    `void` | ReceivingSequenceAgent.`processSend(ISegmentSet objSegmentSet)` Process and populate the sequence numbering.
    `void` | InitiatingSequenceAgent.`processSend(ISegmentSet objSegmentSet)` Process and populate the sequence numbering.

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

    Methods in cdac.medinfo.sdk.hl7282.hl7net.commons that return ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | IClientQueryCancellation.`generateCancellationQuery(java.lang.String strQueryID)` Generates segment set for QCN^J01.
    `ISegmentSet` | IClientInteractiveContinuation.`generateCancellationQuery(java.lang.String strQueryID)` Checks weather the Query is completed or not.
    `ISegmentSet` | IClientInteractiveContinuation.`generateInteractiveQuery(java.lang.String strQueryID)` Retrieves the number of query fired for specified Query ID.
    `ISegmentSet` | IServerInteractiveContinuation.`generateInteractiveResponse(java.lang.String strQueryID)` Retrieves the number of query fired for specified Query ID.
    `ISegmentSet` | IBatchProcessor.`getSegmentSet(IHL7Batch objHL7Batch)` Populates SegemntSet through provided HL7Batch.
    `ISegmentSet` | IBatchProcessor.`getSegmentSet(IHL7BatchFile objHL7BatchFile)` Populates SegemntSet through provided HL7BatchFile.
    `ISegmentSet` | IBatchProcessor.`processSend(IHL7BatchFile objHL7BatchFile)` Retrieves SegmentSet generated through provided HL7BatchFile.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.commons that return types with arguments of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISingleCollection<ISegmentSet>` | IClientQueryCancellation.`getCancelledMessages()` Retrieves all Responses which are canceled by user.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.commons with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `IHL7BatchFile` | IBatchProcessor.`createBatchFile(MessageFactory objMessageFactory, ISegmentSet objSegmentSet)` Creates HL7BatchFile and populate it through provided SegmentSet.
    `EnumSubscriptionType` | IPublishAgent.`getSubscriptionType(ISegmentSet objSegmentSet)` This will check that received message is subscription message or not.
    `void` | IDataProcessor.`onDataReceived(ISegmentSet objSegmentSet)` Adds DataProcessors to Receive SegmentSet.
    `void` | IExceptionReceiver.`onException(java.lang.Exception ex, ISegmentSet objISegmentSet)` Returns The Exception Occurred.
    `IHL7BatchFile` | IBatchProcessor.`populateBatchFile(MessageFactory objMessageFactory, ISegmentSet objSegmentSet)` Populates HL7BatchFile through provided SegmentSet.
    `boolean` | IServerQueryCancellation.`processReceive(ISegmentSet objSegmentSet)` Keep track for the Queries which are received by server.
    `boolean` | IServerInteractiveContinuation.`processReceive(ISegmentSet objSegmentSet)` Keeps the logs of incoming Interactive Queries.
    `void` | ISequenceAgent.`processReceive(ISegmentSet objSegmentSet)` Invoked when system receive message.
    `boolean` | IClientQueryCancellation.`processReceive(ISegmentSet objSegmentSet)` Keeps track for the Responses which are received by client.
    `boolean` | IClientInteractiveContinuation.`processReceive(ISegmentSet objSegmentSet)` Keeps the logs of incoming Interactive Responses.
    `IHL7BatchFile` | IBatchProcessor.`processReceive(MessageFactory objMessageFactory, ISegmentSet objSegmentSet)` Retrieves populated HL7BatchFile through given SegmentSet.
    `boolean` | IServerQueryCancellation.`processSend(ISegmentSet objSegmentSet)` Keeps track for the Responses which are Send by Server.
    `void` | IServerInteractiveContinuation.`processSend(ISegmentSet objSegmentSet)` Keeps the logs of outgoing Interactive Responses.
    `void` | ISequenceAgent.`processSend(ISegmentSet objSegmentSet)` Invoked when system wants to send message.
    `boolean` | IClientQueryCancellation.`processSend(ISegmentSet objSegmentSet)` Keeps track for the Queries which are Send by client.
    `void` | IClientInteractiveContinuation.`processSend(ISegmentSet objSegmentSet)` Keeps the logs of outgoing Interactive Queries.
    `void` | IBufferSender.`sendData(ISegmentSet objSegmentSet)` Gets automatically invoked when ISegmentSet is to be sent to remote system.

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

    Methods in cdac.medinfo.sdk.hl7282.hl7net.communication that return types with arguments of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `ISingleCollection<ISegmentSet>` | MessageStreamSplitter.`splitMessageBuffer(ISegmentSet objSegmentSet)` Reads Byte Array specified and divides them into stream pieces containing single message.

    Methods in cdac.medinfo.sdk.hl7282.hl7net.communication with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `void` | ServerSideMessageAgent.`onDataReceived(ISegmentSet objSegmentSet)` Adds DataProcessors to Receive SegmentSet.
    `void` | ClientSideMessageAgent.`onDataReceived(ISegmentSet objSegmentSet)` Adds DataProcessors to Receive SegmentSet.
    `void` | AuxAgent.`sendData(ISegmentSet objSegmentSetToSend)` Gets automatically invoked when Message is to be sent to remote system.
    `ISingleCollection<ISegmentSet>` | MessageStreamSplitter.`splitMessageBuffer(ISegmentSet objSegmentSet)` Reads Byte Array specified and divides them into stream pieces containing single message.

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

    Methods in cdac.medinfo.sdk.hl7282.hl7net.upperlayer with parameters of type ISegmentSet
    Modifier and Type | Method and Description
    --- | ---
    `void` | UserSession.`onException(java.lang.Exception ex, ISegmentSet objISegmentSet)` Invoked when exception is fetched while processing Message.
    `void` | IProcessHandler.`onException(java.lang.Exception ex, ISegmentSet objISegmentSet)` Invoked when exception is raised.
    `void` | IExceptionListener.`onException(java.lang.Exception ex, ISegmentSet objISegmentSet)` Invoked when exception is raised.
    `void` | ClientSession.`onException(java.lang.Exception ex, ISegmentSet objISegmentSet)` Invoked when exception is fetched while processing Message.