Module io.xlate.staedi

Package io.xlate.edi.schema

Interface EDIControlType

All Superinterfaces:

EDIComplexType, EDIType

public interface EDIControlType
extends EDIComplexType

Provides access to attributes specified for a control structure complex type such as the interchange, group, and transaction envelope structures.

Since:

1.21

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EDIControlType.Type

Method Summary

Modifier and Type	Method	Description
EDIControlType.Type	getCountType()	Get the type of structures
EDIElementPosition	getHeaderRefPosition()	Get the position of the element within the header segment that is used as the control reference/number for the envelope.
EDIElementPosition	getTrailerCountPosition()	Get the position of the element within the trailer segment that is used as the control count for the envelope.
EDIElementPosition	getTrailerRefPosition()	Get the position of the element within the trailer segment that is used as the control reference/number for the envelope.

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

getReferences, getSyntaxRules

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

getCode, getDescription, getId, getTitle, getType, isType

Method Details

getHeaderRefPosition

EDIElementPosition getHeaderRefPosition()

Get the position of the element within the header segment that is used as the control reference/number for the envelope.

Returns:

the position of the element holding the structure's header control reference

getTrailerRefPosition

EDIElementPosition getTrailerRefPosition()

Get the position of the element within the trailer segment that is used as the control reference/number for the envelope.

Returns:

the position of the element holding the structure's trailer control reference

getTrailerCountPosition

EDIElementPosition getTrailerCountPosition()

Get the position of the element within the trailer segment that is used as the control count for the envelope. The actual structures counted are determined by the value returned by getCountType().

Returns:

the position of the element holding the structure's trailer control count

getCountType

EDIControlType.Type getCountType()

Get the type of structures

Returns:

the type of count