Module io.xlate.staedi
Package io.xlate.edi.schema

Interface EDISimpleType

  • All Superinterfaces:
    EDIType
    All Known Subinterfaces:
    ElementImplementation
    public interface EDISimpleType
extends EDIType
    An interface representing the schema of an EDI simple type, AKA an element.

    • Method Detail

      • getScale

        default Integer getScale()
        Returns the scale of this EDISimpleType when the base is NUMERIC. The scale is the number of digits to the right of an implied decimal point.
        Returns:
        the scale of this EDISimpleType if NUMERIC, otherwise null.
        Since:
        1.13

      • hasVersions

        default boolean hasVersions()
        Returns true if this element has additional version(s) defined beyond the default. Versions may be used to specify different minimum/maximum length restrictions or enumerated values that only apply to specific versions a transaction.
        Returns:
        true if this element has version(s), otherwise false
        Since:
        1.8

      • getNumber

        @Deprecated
int getNumber()
        Deprecated.
        (since 1.8, for removal) use EDIType.getCode() and code attribute instead
        Retrieve the element reference number for this type.
        Returns:
        the element reference number as declared in the EDI schema, or -1 if not declared

      • getMinLength

        long getMinLength()
        Retrieve the minLength attribute of the element.
        Returns:
        the minLength attribute

      • getMinLength

        default long getMinLength​(String version)
        Retrieve the minLength attribute for a particular version of the element. The default implementation returns the default (un-versioned) value for the element.
        Parameters:
        version - the version to select
        Returns:
        the minLength attribute for version
        Since:
        1.8

      • getMaxLength

        long getMaxLength()
        Retrieve the maxLength attribute of the element.
        Returns:
        the maxLength attribute

      • getMaxLength

        default long getMaxLength​(String version)
        Retrieve the maxLength attribute for a particular version of the element. The default implementation returns the default (un-versioned) value for the element.
        Parameters:
        version - the version to select
        Returns:
        the maxLength attribute for version
        Since:
        1.8

      • getValueSet

        default Set<String> getValueSet()
        Retrieve the set of enumerated values allowed for this element.
        Returns:
        the set of enumerated values allowed for this element

      • getValueSet

        default Set<String> getValueSet​(String version)
        Retrieve the set of enumerated values allowed for this element for a particular version of the element. The default implementation returns the default (un-versioned) value for the element.
        Parameters:
        version - the version to select
        Returns:
        the set of enumerated values allowed for this element for the given version
        Since:
        1.8

      • getValues

        Map<String,​String> getValues()
        Retrieve the mapping of enumerated values allowed for this element with the associated title values.
        Returns:
        the map of enumerated values and titles allowed for this element
        Since:
        1.22

      • getValues

        default Map<String,​String> getValues​(String version)
        Retrieve the mapping of enumerated values allowed for this element with the associated title values for a particular version of the element. The default implementation returns the default (un-versioned) values for the element.
        Parameters:
        version - the version to select
        Returns:
        the map of enumerated values and titles allowed for this element for the given version
        Since:
        1.22