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

- Packages that use ISegmentKey
  Package | Description
  --- | ---
  cdac.medinfo.sdk.hl7282.baselibs.messagedictionary | Provides classes which enables access and modifications of HL7 Message dictionary.
  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.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.utils | Provides collection framework, collection classes, internationalization and miscellaneous utility classes.

- - ### Uses of ISegmentKey in cdac.medinfo.sdk.hl7282.baselibs.messagedictionary

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messagedictionary that return ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentKey` | SegmentItem.`getName()` Retrieves Name of segment

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messagedictionary with parameters of type ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `IMap` | Map.`getGroupMap(ISegmentKey enumGroupName)` Retrieves Map of specified Group name
    `boolean` | Map.`isFirstLevelMember(ISegmentKey enumSearchSegment)` Verifies whether Segment or Group is present at the first level of HL7 message structure or not.
    `boolean` | Map.`isMember(ISegmentKey enumSearchSegment)` Verifies whether Segment or Group is member of HL7 Message or not according to Message Structure.
    `void` | SegmentItem.`setName(ISegmentKey enumName)` Sets Name of segment

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

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messages that return ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentKey` | Group.`getName()` Return SegmentKey.

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messages with parameters of type ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `void` | Group.`addGroup(ISegmentKey enumSegments, IGroup objGroup)` Adds the group in Collection of data value.
    `void` | Group.`addSegment(ISegmentKey enumSegments, ISegment objSegment)` Adds segment in multi valued paired collection.
    `boolean` | Message.`contains(ISegmentKey enumSegments)` Check weather Segment or Group is present or not.
    `ISingleCollection<IGroup>` | Message.`getGroup(ISegmentKey enumSegments)` Get the Group Collection from the Message with the help of provided Segment Key.
    `ISingleCollection<IGroup>` | Group.`getGroup(ISegmentKey enumGroup)` Gives collection of group of name enumGroup as passed by user.
    `IMap` | Message.`getGroupMap(ISegmentKey enumGroupName)` Retrieves Map of specified Group name.
    `IMap` | Group.`getGroupMap(ISegmentKey enumGroupName)` Retrieves Map of specified Group name
    `ISingleCollection<ISegment>` | Message.`getSegment(ISegmentKey enumSegments)` Get the Segment Collection from the Message with the help of provided Segment Key.
    `ISingleCollection<ISegment>` | Group.`getSegment(ISegmentKey enumSegments)` Gives collection of segment of name enumSegments as passed by user.
    `void` | Message.`removeGroup(ISegmentKey enumSegments)` Remove the Group from the Message.
    `void` | Message.`removeSegment(ISegmentKey enumSegments)` Remove the Segment from the Message.
    `int` | Message.`removeSegment(ISegmentKey enumSearchSegment, boolean isForcefullyRemove)` Removes only first level Segments or Group from the HL7 Message.
    `int` | Message.`removeSegmentAttribute(ISegmentKey removeSegmentKey, int iItemID, boolean isForcefullyRemove)` Removes Attribute of a segment.
    `int` | Message.`removeSegmentAttribute(ISegmentKey removeSegmentKey, java.lang.String strAttributeName, boolean isForcefullyRemove)` Removes Attribute of a segment.
    `void` | Group.`setName(ISegmentKey enumName)` Sets the name of group.
    `int` | Message.`updateSegmentAttribute(ISegmentKey removeSegmentKey, int iItemID, IDataType objIDataType)` Removes Attribute of a segment.
    `int` | Message.`updateSegmentAttribute(ISegmentKey removeSegmentKey, int iItemID, java.lang.String strSegmentStream, IDelimiter objDelimiter)` Removes Attribute of a segment.

    Method parameters in cdac.medinfo.sdk.hl7282.baselibs.messages with type arguments of type ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `int` | Message.`removeSegmentAttribute(MultiValuedPairedCollection<ISegmentKey,java.lang.Integer> objSegmentKeyCollection, boolean isForcefullyRemove)` Removes Attribute of a segment.
    `int` | Message.`removeSegments(ISingleCollection<ISegmentKey> objSegmentKeyCollection, boolean isForcefullyRemove)` Removes collection of first level message or segments from HL7 message

    Constructors in cdac.medinfo.sdk.hl7282.baselibs.messages with parameters of type ISegmentKey
    Constructor and Description
    `Group(ISegmentKey enumGroups, IMap objMessageMap)` This constructor creates object of MultiValuedPairedCollection and initializes the Group Name with enumGroups.

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

    Methods in cdac.medinfo.sdk.hl7282.baselibs.segments that return ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentKey` | Segment.`getName()` This method returns SegmentName.

    Methods in cdac.medinfo.sdk.hl7282.baselibs.segments with parameters of type ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `void` | Segment.`setName(ISegmentKey enumName)` This method Sets SegmentName.

    Constructors in cdac.medinfo.sdk.hl7282.baselibs.segments with parameters of type ISegmentKey
    Constructor and Description
    `Segment(ISegmentKey objSegmentKey)` Initialize instance member variable.
    `Segment(ISegmentKey objSegmentKey, ISegmentMap objSegmentMap)` Initialize instance member variable.

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

    Methods in cdac.medinfo.sdk.hl7282.commoninterface that return ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentKey` | ISegment.`getName()` Returns Segment Name.
    `ISegmentKey` | IGroup.`getName()` Return SegmentKey.

    Methods in cdac.medinfo.sdk.hl7282.commoninterface with parameters of type ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `void` | IGroup.`addGroup(ISegmentKey enumSegments, IGroup objGroup)` Adds the group in Collection of data value.
    `void` | IGroup.`addSegment(ISegmentKey enumSegments, ISegment objSegment)` Adds segment in multi valued paired collection.
    `ISingleCollection<IGroup>` | IGroup.`getGroup(ISegmentKey enumGroup)` Gives collection of group of name enumGroup as passed by user.
    `IMap` | IGroup.`getGroupMap(ISegmentKey enumGroupName)` Retrieves Map of specified Group name.
    `ISingleCollection<ISegment>` | IGroup.`getSegment(ISegmentKey enumSegments)` Gives collection of segment of name enumSegments as passed by user.
    `void` | ISegment.`setName(ISegmentKey enumName)` Sets Segment Name.
    `void` | IGroup.`setName(ISegmentKey enumName)` Sets the name of group.

  - ### Uses of ISegmentKey in cdac.medinfo.sdk.hl7282.utils

    Classes in cdac.medinfo.sdk.hl7282.utils that implement ISegmentKey
    Modifier and Type | Class and Description
    --- | ---
    `class` | `EnumSegments` This Enum contains all segments and Groups of HL7.

    Methods in cdac.medinfo.sdk.hl7282.utils that return ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `ISegmentKey` | ISegmentItem.`getName()` Retrieves Name of segment
    `static ISegmentKey` | StandardMethods.`getSegmentEnum(java.lang.String strSegmentName)` Gives the EnumSegment Name.

    Methods in cdac.medinfo.sdk.hl7282.utils with parameters of type ISegmentKey
    Modifier and Type | Method and Description
    --- | ---
    `IMap` | IMap.`getGroupMap(ISegmentKey enumGroupName)` Retrieves Map of specified Group name
    `boolean` | IMap.`isFirstLevelMember(ISegmentKey enumSearchSegment)` Verifies whether Segment or Group is present at the first level of HL7 message structure or not.
    `boolean` | IMap.`isMember(ISegmentKey enumSearchSegment)` Verifies whether Segment or Group is member of HL7 Message or not according to Message Structure.
    `void` | ISegmentItem.`setName(ISegmentKey enumName)` Sets Name of segment