EDIElement Type
An Element within an EDI Segment.
Remarks
An EDI Segment contains one or more Elements. Elements can either be simple (they just contain a value) or they may be composite (containing more than one Component).
A simple element will simply contain a Value. For a composite element you must iterate over the components it contains by setting the ComponentIndex field, and then using the ComponentValue field to get the value at the corresponding index.
Fields
|
ComponentCount Integer |
Number of components in the current element. | ||||||||||||||||
|
ComponentIndex Integer |
The index of the selected component of the current element. ComponentIndex valid values are from 0 to (ComponentCount - 1). | ||||||||||||||||
|
ComponentName String |
The name of the component selected by ComponentIndex, according to the Transaction Set schema. | ||||||||||||||||
|
ComponentType String |
The data type of component selected by ComponentIndex, according to the Transaction Set Schema. Possible values are:
| ||||||||||||||||
|
ComponentValue String |
The value of the component selected by ComponentIndex. | ||||||||||||||||
|
DataType String |
The data type of this EDI element, according to the Transaction Set Schema. Possible values are:
| ||||||||||||||||
|
Name String |
The name of this EDI element, according to the Transaction Set schema. | ||||||||||||||||
|
RepeatCount Integer |
The number of times this element is repeated in the in the segment. If the element is not repeated this will return 0. To access the repeated element values set RepeatIndex. | ||||||||||||||||
|
RepeatIndex Integer |
The index of the selected instance of this repeatable element. RepeatIndex valid values are from 0 to (RepeatCount - 1). Setting RepeatIndex will affect the value reported by all other properties. | ||||||||||||||||
|
Value String |
The value directly associated with this EDI element. Note that this field will be populated with the entire element contents when a composite element exists. The components of the composite element will also be parsed out into the ComponentName, ComponentType, and ComponentValue fields. |