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

Interface EDIReference

All Known Subinterfaces:
CompositeImplementation, EDITypeImplementation, ElementImplementation, LoopImplementation, PolymorphicImplementation, SegmentImplementation
public interface EDIReference

  • Method Summary

    Modifier and Type Method Description
    String getDescription()
    Retrieve the description for this reference, if available.
    int getMaxOccurs()  
    default int getMaxOccurs​(String version)
    Retrieve the maxOccurs attribute for a particular version of the element.
    int getMinOccurs()  
    default int getMinOccurs​(String version)
    Retrieve the minOccurs attribute for a particular version of the element.
    EDIType getReferencedType()  
    String getTitle()
    Retrieve the title for this reference, if available.
    default boolean hasVersions()
    Returns true if this element has additional version(s) defined beyond the default.

  • Method Details

    • getReferencedType

      EDIType getReferencedType()

    • getMinOccurs

      int getMinOccurs()

    • getMaxOccurs

      int getMaxOccurs()

    • 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 occurrence restrictions that only apply to specific versions of a transaction.
      Returns:
      true if this element has version(s), otherwise false
      Since:
      1.8

    • getMinOccurs

      default int getMinOccurs​(String version)
      Retrieve the minOccurs 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 minOccurs attribute for version
      Since:
      1.8

    • getMaxOccurs

      default int getMaxOccurs​(String version)
      Retrieve the maxOccurs 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 maxOccurs attribute for version
      Since:
      1.8

    • getTitle

      String getTitle()
      Retrieve the title for this reference, if available.
      Returns:
      the reference's title
      Since:
      1.10

    • getDescription

      String getDescription()
      Retrieve the description for this reference, if available.
      Returns:
      the reference's description
      Since:
      1.10