Class X12CodeListValidationRule

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

Defines a validation rule that modifies the allowed code values for a specific X12 element. This rule allows you to add or remove valid codes from an element's standard code list, providing flexibility to accommodate trading partner-specific requirements or industry variations. You can specify codes to add to expand the allowed values beyond the X12 standard, or codes to remove to restrict the allowed values for stricter validation.

See Also:

  • Method Details

    • elementId

      public final String elementId()

      Specifies the four-digit element ID to which the code list modifications apply. This identifies which X12 element will have its allowed code values modified.

      Returns:
      Specifies the four-digit element ID to which the code list modifications apply. This identifies which X12 element will have its allowed code values modified.

    • hasCodesToAdd

      public final boolean hasCodesToAdd()
      For responses, this returns true if the service returned a value for the CodesToAdd property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • codesToAdd

      public final List<String> codesToAdd()

      Specifies a list of code values to add to the element's allowed values. These codes will be considered valid for the specified element in addition to the standard codes defined by the X12 specification.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCodesToAdd() method.

      Returns:
      Specifies a list of code values to add to the element's allowed values. These codes will be considered valid for the specified element in addition to the standard codes defined by the X12 specification.

    • hasCodesToRemove

      public final boolean hasCodesToRemove()
      For responses, this returns true if the service returned a value for the CodesToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • codesToRemove

      public final List<String> codesToRemove()

      Specifies a list of code values to remove from the element's allowed values. These codes will be considered invalid for the specified element, even if they are part of the standard codes defined by the X12 specification.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCodesToRemove() method.

      Returns:
      Specifies a list of code values to remove from the element's allowed values. These codes will be considered invalid for the specified element, even if they are part of the standard codes defined by the X12 specification.

    • toBuilder

      public X12CodeListValidationRule.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<X12CodeListValidationRule.Builder,X12CodeListValidationRule>
      Returns:
      a builder for type T

    • builder

      public static X12CodeListValidationRule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends X12CodeListValidationRule.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.