xpfCreateNestedScratchAggr

FUNCTION xpfCreateNestedScratchAggr (parentAggrId               : AGGREGATE OF GENERIC;
                                     index                      : INTEGER;
                                      aggregateType, lowerBound  : INTEGER;
                                     upperBound, valueType      : INTEGER;
                                     domainId                   : GENERIC)
                                     scratchAggrId              : AGGREGATE OF GENERIC;
                

The xpfCreateNestedScratchAggr function creates a nested scratch aggregate instance in the scratch model, i.e., a scratch aggregate will not be written to the persistent EDMdatabase. The parent aggregate must be a scratch aggregate with element data type sdaiAGGR (XPXAGGREGATE). All EDMinterface access operations defined for persistent aggregates are applicable on scratch aggregates. The created aggregate will be inserted in the parent aggregate according to the aggregate type of the parent aggregate:

•     ARRAY : Inserted as the element specified by the <index> argument
•     LIST: Appended to the list
•     BAG and SET: Added to the parent aggregate.

The scratch model is a volatile model that is deleted when the session is closed or the database is closed. The scratch model can hold instances of any instance types defined by any dictionary models in the EDMdatabase. Each open session has it own unique scratch model, hence the data in a scratch model cannot be shared between concurrent users of an EDMdatabase. The scratch model will implicitly be created and open for write access when the session is opened. A scratch aggregate can be deleted by the sdaiDeleteAggr operation. A nested scratch aggregate will implicitly be deleted when the parent scratch aggregate is deleted. All scratch aggregates are deleted when the open session is closed or when the database is closed.

Arguments

Return Value

Options

Example

<Missing Example>

See also