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

- Packages that use IHL7Stream
  Package | Description
  --- | ---
  cdac.medinfo.sdk.hl7282.baselibs | Provides classes of Primitive and Composite Datatypes.
  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.hl7net.commons | Provides Interfaces which are required to be implemented by Session classes, Network Agents & MessageAgents of Client Server.
  cdac.medinfo.sdk.hl7282.hl7streams | Provides classes which read and write from the stream.

- - ### Uses of IHL7Stream in cdac.medinfo.sdk.hl7282.baselibs

    Methods in cdac.medinfo.sdk.hl7282.baselibs with parameters of type IHL7Stream
    Modifier and Type | Method and Description
    --- | ---
    `void` | CompositeDataType.`dumpDataType(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter, int iLevel)` Serializes Composite Data Type information like it name, Attribute name and its values.
    `int` | UN.`write(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Writes the unknown data to the stream from the byte buffer This function writes the Data Value to the Stream
    `int` | PrimitiveDataType.`write(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Method writes the data to the Stream.
    `int` | CompositeDataType.`write(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Method writes the data to the Stream.

  - ### Uses of IHL7Stream in cdac.medinfo.sdk.hl7282.baselibs.messages

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messages with parameters of type IHL7Stream
    Modifier and Type | Method and Description
    --- | ---
    `void` | Message.`dumpMessage(IHL7Stream objIHL7Stream)` Serializes message Information in the form of Attribute Name and its Value.
    `boolean` | HL7MessageValidator.`validate(IHL7Stream objIHL7Stream)` Validates the stream of HL7 message.
    `int` | Message.`writeToXML(IHL7Stream objIHL7Stream)` Serializes message Information in the form of Attribute Name and its Value.

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

    Methods in cdac.medinfo.sdk.hl7282.baselibs.parserserializer with parameters of type IHL7Stream
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentSet` | HL7Parser.`parse(IHL7Stream objHL7Stream)` Parses the HL7Stream which contains a HL7 Message and populates the SegmentSet accordingly.
    `boolean` | HL7Serializer.`serialize(ISegmentSet objSegmentSet, IHL7Stream objHL7Stream)` Serializes the SegmentSet on given stream.

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

    Methods in cdac.medinfo.sdk.hl7282.baselibs.segments with parameters of type IHL7Stream
    Modifier and Type | Method and Description
    --- | ---
    `void` | Segment.`dumpSegment(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter, int iLevel)` Serializes Segment information like it name, Attribute name and its values.
    `int` | Segment.`serialize(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Serializes HL7 Message objects.
    `int` | RDT.`serialize(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Serializes HL7 Message objects.
    `int` | QPD.`serialize(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Serializes HL7 Message objects.
    `int` | MSH.`serialize(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Serializes HL7 Message objects.
    `int` | FHS.`serialize(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Serializes HL7 Message objects.
    `int` | BHS.`serialize(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Serializes HL7 Message objects.

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

    Methods in cdac.medinfo.sdk.hl7282.commoninterface with parameters of type IHL7Stream
    Modifier and Type | Method and Description
    --- | ---
    `void` | ISegment.`dumpSegment(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter, int iLevel)` Dumps information of segments like Attribute Name and its value.
    `int` | ISegment.`serialize(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Serializes HL7 Message objects.
    `int` | IDataType.`write(IHL7Stream objIHL7Stream, IDelimiter objIDelimiter)` Writes data to the Stream.
    `int` | IDelimiter.`writeDelimiters(IHL7Stream objIHL7Stream)` Writes the Encoding characters field.

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

    Methods in cdac.medinfo.sdk.hl7282.hl7net.commons with parameters of type IHL7Stream
    Modifier and Type | Method and Description
    --- | ---
    `static byte[]` | StandardUtilityMethods.`createReplicateStream(IHL7Stream objHL7BufferStream, byte[] readBytes)` This method takes object of HL7buffer stream and returns out the byteArrayInputStream by making replica of received stream.
    `static Segment` | StandardUtilityMethods.`getMessageBatchHeader(IHL7Stream objHL7BufferStream)`
    `int` | IBatch.`parse(IHL7Stream objIHL7Stream)` Parses HL7 Batch Strings from any Stream into HL7 Batch objects.
    `int` | IBatch.`serialize(IHL7Stream objIHL7Stream)` Serializes HL7 Batch objects.

  - ### Uses of IHL7Stream in cdac.medinfo.sdk.hl7282.hl7streams

    Classes in cdac.medinfo.sdk.hl7282.hl7streams that implement IHL7Stream
    Modifier and Type | Class and Description
    --- | ---
    `class` | `HL7BufferStream` This class is specialized in the reading/writing operations on the byte array
    `class` | `HL7FileStream` This class is specialized in the reading/writing operations on the file.
    `class` | `HL7Stream` This is an abstract class providing all the common functionality and refernce for all extending classes.