Package software.amazon.awssdk.services.b2bi.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	X12InterchangeControlHeaders.Builder

Method Summary

Modifier and Type	Method	Description
String	acknowledgmentRequestedCode()	Located at position ISA-14 in the header.
static X12InterchangeControlHeaders.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	receiverId()	Located at position ISA-08 in the header.
String	receiverIdQualifier()	Located at position ISA-07 in the header.
String	repetitionSeparator()	Located at position ISA-11 in the header.
List<SdkField<?>>	sdkFields()
String	senderId()	Located at position ISA-06 in the header.
String	senderIdQualifier()	Located at position ISA-05 in the header.
static Class<? extends X12InterchangeControlHeaders.Builder>	serializableBuilderClass()
X12InterchangeControlHeaders.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	usageIndicatorCode()	Located at position ISA-15 in the header.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<X12InterchangeControlHeaders.Builder,X12InterchangeControlHeaders>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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