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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EDISimpleType.Base

Nested classes/interfaces inherited from interface io.xlate.edi.schema.EDIType

EDIType.Type

Method Summary

Modifier and Type	Method	Description
EDISimpleType.Base	getBase()
long	getMaxLength()	Retrieve the maxLength attribute of the element.
default long	getMaxLength(String version)	Retrieve the maxLength attribute for a particular version of the element.
long	getMinLength()	Retrieve the minLength attribute of the element.
default long	getMinLength(String version)	Retrieve the minLength attribute for a particular version of the element.
int	getNumber()	Deprecated. (since 1.8, for removal) use EDIType.getCode() and code attribute instead
default Integer	getScale()	Returns the scale of this EDISimpleType when the base is NUMERIC.
Set<String>	getValueSet()	Retrieve the set of enumerated values allowed for this element.
default Set<String>	getValueSet(String version)	Retrieve the set of enumerated values allowed for this element for a particular version of the element.
default boolean	hasVersions()	Returns true if this element has additional version(s) defined beyond the default.

Methods inherited from interface io.xlate.edi.schema.EDIType

getCode, getDescription, getId, getTitle, getType, isType

Method Detail

getBase

EDISimpleType.Base getBase()

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

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 version

Since:

1.8