Class X12InterchangeControlHeaders

java.lang.Object
software.amazon.awssdk.services.b2bi.model.X12InterchangeControlHeaders
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<X12InterchangeControlHeaders.Builder,X12InterchangeControlHeaders>
@Generated("software.amazon.awssdk:codegen") public final class X12InterchangeControlHeaders extends Object implements SdkPojo, Serializable, ToCopyableBuilder<X12InterchangeControlHeaders.Builder,X12InterchangeControlHeaders>

In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope. It contains information about the sender and receiver, the date and time of transmission, and the X12 version being used. It also includes delivery information, such as the sender and receiver IDs.

See Also:

  • Method Details

    • senderIdQualifier

      public final String senderIdQualifier()

      Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

      Returns:
      Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

    • senderId

      public final String senderId()

      Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

      Returns:
      Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

    • receiverIdQualifier

      public final String receiverIdQualifier()

      Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

      Returns:
      Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

    • receiverId

      public final String receiverId()

      Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

      Returns:
      Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

    • repetitionSeparator

      public final String repetitionSeparator()

      Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

      This parameter is only honored for version greater than 401 (VERSION_4010 and higher).

      For versions less than 401, this field is called StandardsId, in which case our service sets the value to U.

      Returns:
      Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

      This parameter is only honored for version greater than 401 (VERSION_4010 and higher).

      For versions less than 401, this field is called StandardsId, in which case our service sets the value to U.

    • acknowledgmentRequestedCode

      public final String acknowledgmentRequestedCode()

      Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

      Returns:
      Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

    • usageIndicatorCode

      public final String usageIndicatorCode()

      Located at position ISA-15 in the header. Specifies how this interchange is being used:

      • T indicates this interchange is for testing.

      • P indicates this interchange is for production.

      • I indicates this interchange is informational.

      Returns:
      Located at position ISA-15 in the header. Specifies how this interchange is being used:

      • T indicates this interchange is for testing.

      • P indicates this interchange is for production.

      • I indicates this interchange is informational.

    • toBuilder

      public X12InterchangeControlHeaders.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<X12InterchangeControlHeaders.Builder,X12InterchangeControlHeaders>
      Returns:
      a builder for type T

    • builder

      public static X12InterchangeControlHeaders.Builder builder()

    • serializableBuilderClass

      public static Class<? extends X12InterchangeControlHeaders.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.