SYNTAX:
xpfCreateNestedTypedAggrByIterator (iterator : GENERIC; typePath : LIST OF GENERIC) newAggregateId : AGGREGATE OF GENERIC;
The xpfCreateNestedTypedAggrByIterator function creates a typed aggregate instance and sets the created aggregate as an element in an already existing aggregate instance, i.e., a nested aggregate is the result of this operation. The already existing aggregate will be the parent aggregate of the new created aggregate and the new created typed aggregate will be a child aggregate of the already existing aggregate. The created aggregateID is returned in the argument <newAggregateId>.
Nested typed aggregates must be used when the data type specification of the elements of the parent aggregate is not uniquely defined in the appropriate Express schema. This can only occur when the actual element specification is of type SELECT.
All EDMexpressX access operation defined for untyped aggregates is applicable on typed aggregates.
Nested typed aggregates must be used when the data type specification of the elements of the parent aggregate is not uniquely defined in the appropriate Express schema. This can only occur when the actual element specification is of type SELECT.
A struct of type SdaiSelect containing the aggregate typing should be supplied in the argument <typePath>.
This operation is legal for all parent aggregates of any aggregate types with the following effect:
- For ARRAY : The new created typed aggregate will be inserted at the element pointed to by the specified <iterator>. If an element already exists in this position, the existing element will be replaced by the new one.
- For LIST: The new created typed aggregate will be appended to the parent list aggregate
- For BAG and SET: The new typed aggregate will be added to the parent bag or set aggregate.
A numeric aggregateID that uniquely identifies the new created aggregate instance in the EDMdatabase will be the returned function value. This aggregateID should be used to identify this particular aggregate instance in subsequent EDMexpressX operations. An aggregateID is persistent and fixed, i.e. it is constant throughout the lifetime of the actual aggregate instance.
An aggregateID can never be used as a data value in any of the EDMexpressX put operations, it can only be returned as data value in EDMexpressX get operations.
This operation is only applicable to aggregates owned by application instances.
The model that will hold the new created aggregate must be open for write access.
This function is equivalent to the EDMinterface function edmiCreateNestedTypedAggrByIterator.
See also xpxCreateNestedTypedAggrByIterator.