Module io.xlate.staedi
Package io.xlate.edi.stream

Enum EDIStreamValidationError

java.lang.Object
java.lang.Enum<EDIStreamValidationError>
io.xlate.edi.stream.EDIStreamValidationError
All Implemented Interfaces:
Serializable, Comparable<EDIStreamValidationError>
public enum EDIStreamValidationError extends Enum<EDIStreamValidationError>
Enumeration of validation error types that may be encountered by the EDIStreamReader or EDIStreamWriter.
See Also:

  • Enum Constant Details

    • NONE

      public static final EDIStreamValidationError NONE
      No error

    • UNRECOGNIZED_SEGMENT_ID

      public static final EDIStreamValidationError UNRECOGNIZED_SEGMENT_ID
      Deprecated.
      Not used by StAEDI - reserved for future use.
      An unrecognized (undefined) segment was encountered in the data stream.

    • UNEXPECTED_SEGMENT

      public static final EDIStreamValidationError UNEXPECTED_SEGMENT
      Segment was received in an unexpected position in the data stream. This error may occur when a segment is encountered in a loop for which it is not defined.

    • MANDATORY_SEGMENT_MISSING

      public static final EDIStreamValidationError MANDATORY_SEGMENT_MISSING
      Segment was defined (via a schema) with a minimum number of occurrences, but the number of occurrences encountered in the data stream does not meet the requirement.

    • LOOP_OCCURS_OVER_MAXIMUM_TIMES

      public static final EDIStreamValidationError LOOP_OCCURS_OVER_MAXIMUM_TIMES
      Loop encountered in the data stream has more occurrences than allowed by the configured schema.

    • SEGMENT_EXCEEDS_MAXIMUM_USE

      public static final EDIStreamValidationError SEGMENT_EXCEEDS_MAXIMUM_USE
      Segment encountered in the data stream has more occurrences than allowed by the configured schema.

    • SEGMENT_NOT_IN_DEFINED_TRANSACTION_SET

      public static final EDIStreamValidationError SEGMENT_NOT_IN_DEFINED_TRANSACTION_SET
      An unrecognized (undefined) segment was encountered in the data stream.

    • SEGMENT_NOT_IN_PROPER_SEQUENCE

      public static final EDIStreamValidationError SEGMENT_NOT_IN_PROPER_SEQUENCE
      Segment was encountered out of order. This will occur if the segment is valid within the current data loop, otherwise the error will be UNEXPECTED_SEGMENT.

    • SEGMENT_HAS_DATA_ELEMENT_ERRORS

      public static final EDIStreamValidationError SEGMENT_HAS_DATA_ELEMENT_ERRORS
      Deprecated.
      Not used by StAEDI - reserved for future use.
      Segment contains data element errors.

    • IMPLEMENTATION_UNUSED_SEGMENT_PRESENT

      public static final EDIStreamValidationError IMPLEMENTATION_UNUSED_SEGMENT_PRESENT
      Segment is defined as unused (maximum use is zero) in the schema but was encountered in the data stream.

    • IMPLEMENTATION_DEPENDENT_SEGMENT_MISSING

      public static final EDIStreamValidationError IMPLEMENTATION_DEPENDENT_SEGMENT_MISSING
      Deprecated.
      Not used by StAEDI - reserved for future use.

    • IMPLEMENTATION_LOOP_OCCURS_UNDER_MINIMUM_TIMES

      public static final EDIStreamValidationError IMPLEMENTATION_LOOP_OCCURS_UNDER_MINIMUM_TIMES
      Loop is defined with a minimum number of occurrences in the implementation schema but too few were encountered in the data stream.

    • IMPLEMENTATION_SEGMENT_BELOW_MINIMUM_USE

      public static final EDIStreamValidationError IMPLEMENTATION_SEGMENT_BELOW_MINIMUM_USE
      Segment is defined with a minimum number of occurrences in the implementation schema but too few were encountered in the data stream.

    • IMPLEMENTATION_DEPENDENT_UNUSED_SEGMENT_PRESENT

      public static final EDIStreamValidationError IMPLEMENTATION_DEPENDENT_UNUSED_SEGMENT_PRESENT
      Deprecated.
      Not used by StAEDI - reserved for future use.

    • CONDITIONAL_REQUIRED_SEGMENT_MISSING

      public static final EDIStreamValidationError CONDITIONAL_REQUIRED_SEGMENT_MISSING
      Segment is configured as conditionally required (relative to other segments in the loop) in the schema but was not present in the data stream.

    • SEGMENT_EXCLUSION_CONDITION_VIOLATED

      public static final EDIStreamValidationError SEGMENT_EXCLUSION_CONDITION_VIOLATED
      Segment is configured as conditionally excluded (relative to other segments in the loop) in the schema but was present in the data stream.

    • REQUIRED_DATA_ELEMENT_MISSING

      public static final EDIStreamValidationError REQUIRED_DATA_ELEMENT_MISSING
      Element was defined (via a schema) with a minimum number of occurrences but the number of occurrences encountered in the data stream does not meet the requirement.

    • CONDITIONAL_REQUIRED_DATA_ELEMENT_MISSING

      public static final EDIStreamValidationError CONDITIONAL_REQUIRED_DATA_ELEMENT_MISSING
      Element is configured as conditionally required (relative to other elements in the segment) in the schema but was not present in the data stream.

    • TOO_MANY_DATA_ELEMENTS

      public static final EDIStreamValidationError TOO_MANY_DATA_ELEMENTS
      Element is configured as conditionally required (relative to other elements in the segment) in the schema but was not present in the data stream.

    • EXCLUSION_CONDITION_VIOLATED

      public static final EDIStreamValidationError EXCLUSION_CONDITION_VIOLATED
      Element is configured as conditionally excluded (relative to other elements in the segment) in the schema but was present in the data stream.

    • TOO_MANY_REPETITIONS

      public static final EDIStreamValidationError TOO_MANY_REPETITIONS
      Element repeats more times than allowed by the configured schema.

    • TOO_MANY_COMPONENTS

      public static final EDIStreamValidationError TOO_MANY_COMPONENTS
      Element contains more components than defined by the configured schema.

    • IMPLEMENTATION_DEPENDENT_DATA_ELEMENT_MISSING

      public static final EDIStreamValidationError IMPLEMENTATION_DEPENDENT_DATA_ELEMENT_MISSING
      Deprecated.
      Not used by StAEDI - reserved for future use.

    • IMPLEMENTATION_UNUSED_DATA_ELEMENT_PRESENT

      public static final EDIStreamValidationError IMPLEMENTATION_UNUSED_DATA_ELEMENT_PRESENT
      Element is defined as unused (maximum use is zero) in the schema but was encountered in the data stream.

    • IMPLEMENTATION_TOO_FEW_REPETITIONS

      public static final EDIStreamValidationError IMPLEMENTATION_TOO_FEW_REPETITIONS
      Element is defined with a minimum number of occurrences in the implementation schema but too few were encountered in the data stream.

    • IMPLEMENTATION_DEPENDENT_UNUSED_DATA_ELEMENT_PRESENT

      public static final EDIStreamValidationError IMPLEMENTATION_DEPENDENT_UNUSED_DATA_ELEMENT_PRESENT
      Deprecated.
      Not used by StAEDI - reserved for future use.

    • DATA_ELEMENT_TOO_SHORT

      public static final EDIStreamValidationError DATA_ELEMENT_TOO_SHORT
      Element length is less than the minimum length required by the configured schema.

    • DATA_ELEMENT_TOO_LONG

      public static final EDIStreamValidationError DATA_ELEMENT_TOO_LONG
      Element length is greater than the maximum length allowed by the configured schema.

    • INVALID_CHARACTER_DATA

      public static final EDIStreamValidationError INVALID_CHARACTER_DATA
      Element contains invalid character data.

    • INVALID_CODE_VALUE

      public static final EDIStreamValidationError INVALID_CODE_VALUE
      Element contains a value that is not present in the set of values configured in the schema.

    • INVALID_DATE

      public static final EDIStreamValidationError INVALID_DATE
      Element is defined with type EDISimpleType.Base.DATE but the data encountered does not match formatted as a date.

    • INVALID_TIME

      public static final EDIStreamValidationError INVALID_TIME
      Element is defined with type EDISimpleType.Base.TIME but the data encountered does not match formatted as a time.

    • IMPLEMENTATION_INVALID_CODE_VALUE

      public static final EDIStreamValidationError IMPLEMENTATION_INVALID_CODE_VALUE
      Element contains a value that is not present in the set of values configured in the implementation schema.

    • IMPLEMENTATION_PATTERN_MATCH_FAILURE

      public static final EDIStreamValidationError IMPLEMENTATION_PATTERN_MATCH_FAILURE
      Deprecated.
      Not used by StAEDI - reserved for future use.

    • CONTROL_REFERENCE_MISMATCH

      public static final EDIStreamValidationError CONTROL_REFERENCE_MISMATCH
      Control number/reference in the trailer segment does not match the value encountered in the header.

    • CONTROL_COUNT_DOES_NOT_MATCH_ACTUAL_COUNT

      public static final EDIStreamValidationError CONTROL_COUNT_DOES_NOT_MATCH_ACTUAL_COUNT
      Control count (e.g. count of segments, transactions, or functional groups) encountered in the trailer does not match the actual count in the stream.

  • Method Details

    • values

      public static EDIStreamValidationError[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static EDIStreamValidationError valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getCategory

      public EDIStreamEvent getCategory()
      Provides the category of the validation error. The category is one of the EDIStreamEvents where EDIStreamEvent.isError() is true.
      Returns:
      the EDIStreamEvent category of the validation error.