IFunctionalGroup¶
IFunctionalGroup is the contract implemented by FunctionalGroup; it extends ISegmentGroup with the GS/GE header/trailer and nested TransactionSets surface specific to a functional group envelope.
Purpose¶
- Declares the typed
Header/Trailer(GS/GE) accessors, rawHeaderSegment/TrailerSegment, memberSegments, andTransactionSetsthat any functional-group implementation must provide.
Context¶
- Namespace:
SAIF.Common.Files.Edi - Assembly/package:
SAIF.Framework.Common.Files - Extends:
ISegmentGroup
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| TransactionSets | ITransactionSetContainer TransactionSets { get; } |
The transaction sets (ST/SE envelopes) nested within this functional group. |
| Header | GsSegment Header { get; } |
The strongly-typed GS (functional group header) segment for this group. |
| Trailer | GeSegment Trailer { get; } |
The strongly-typed GE (functional group trailer) segment for this group. |
| HeaderSegment | IEdiSegment HeaderSegment { get; } |
The raw GS segment that opens this group. |
| TrailerSegment | IEdiSegment TrailerSegment { get; } |
The raw GE segment that closes this group. |
| Segments | IEnumerable<IEdiSegment> Segments { get; } |
This group's member segments with the GS/GE control segments excluded (BR-033). |
Inherited public members¶
Members in this section are inherited from ISegmentGroup in SAIF.Framework.Common.Files. They are available on this type through inheritance.
| Member | Signature | Purpose | Origin |
|---|---|---|---|
| Index | int Index { get; set; } |
The sequential ordinal assigned to this functional group among its siblings. | SAIF.Framework.Common.Files — ISegmentGroup |
| Key | string Key { get; set; } |
The GS06 group control number value that uniquely identifies this functional group (BR-034). | SAIF.Framework.Common.Files — ISegmentGroup |
| SegmentGroupId | string SegmentGroupId { get; set; } |
The segment tag ("GS") that this group was delimited by during parsing. |
SAIF.Framework.Common.Files — ISegmentGroup |
| Level | int Level { get; set; } |
The nesting depth of this group. | SAIF.Framework.Common.Files — ISegmentGroup |
Sources¶
- Common\SAIF.Common.Files\Edi\IFunctionalGroup.cs