Package software.amazon.awscdk.services.b2bi

Interface CfnPartnership.X12InterchangeControlHeadersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPartnership.X12InterchangeControlHeadersProperty.Jsii$Proxy

Enclosing class:

CfnPartnership

@Stability(Stable)
public static interface CfnPartnership.X12InterchangeControlHeadersProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.b2bi.*;
 X12InterchangeControlHeadersProperty x12InterchangeControlHeadersProperty = X12InterchangeControlHeadersProperty.builder()
         .acknowledgmentRequestedCode("acknowledgmentRequestedCode")
         .receiverId("receiverId")
         .receiverIdQualifier("receiverIdQualifier")
         .repetitionSeparator("repetitionSeparator")
         .senderId("senderId")
         .senderIdQualifier("senderIdQualifier")
         .usageIndicatorCode("usageIndicatorCode")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPartnership.X12InterchangeControlHeadersProperty.Builder	A builder for CfnPartnership.X12InterchangeControlHeadersProperty
static final class	CfnPartnership.X12InterchangeControlHeadersProperty.Jsii$Proxy	An implementation for CfnPartnership.X12InterchangeControlHeadersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPartnership.X12InterchangeControlHeadersProperty.Builder	builder()
default String	getAcknowledgmentRequestedCode()	Located at position ISA-14 in the header.
default String	getReceiverId()	Located at position ISA-08 in the header.
default String	getReceiverIdQualifier()	Located at position ISA-07 in the header.
default String	getRepetitionSeparator()	Located at position ISA-11 in the header.
default String	getSenderId()	Located at position ISA-06 in the header.
default String	getSenderIdQualifier()	Located at position ISA-05 in the header.
default String	getUsageIndicatorCode()	Located at position ISA-15 in the header.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAcknowledgmentRequestedCode

@Stability(Stable)
@Nullable
default String getAcknowledgmentRequestedCode()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-acknowledgmentrequestedcode

getReceiverId

@Stability(Stable)
@Nullable
default String getReceiverId()

Located at position ISA-08 in the header.

This value (along with the receiverIdQualifier ) identifies the intended recipient of the interchange.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiverid

getReceiverIdQualifier

@Stability(Stable)
@Nullable
default String getReceiverIdQualifier()

Located at position ISA-07 in the header.

Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiveridqualifier

getRepetitionSeparator

@Stability(Stable)
@Nullable
default String getRepetitionSeparator()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-repetitionseparator

getSenderId

@Stability(Stable)
@Nullable
default String getSenderId()

Located at position ISA-06 in the header.

This value (along with the senderIdQualifier ) identifies the sender of the interchange.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderid

getSenderIdQualifier

@Stability(Stable)
@Nullable
default String getSenderIdQualifier()

Located at position ISA-05 in the header.

Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderidqualifier

getUsageIndicatorCode

@Stability(Stable)
@Nullable
default String getUsageIndicatorCode()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-usageindicatorcode

builder

@Stability(Stable)
static CfnPartnership.X12InterchangeControlHeadersProperty.Builder builder()

Returns:

a CfnPartnership.X12InterchangeControlHeadersProperty.Builder of CfnPartnership.X12InterchangeControlHeadersProperty