xpfCreateUnionAggrBN

 
SYNTAX:
 
xpfCreateUnionAggrBN (modelId      : GENERIC;
                       entities    : LIST OF STRING)  unionAggrId   : SET OF GENERIC;
 
The xpfCreateUnionAggrBN function creates a union aggregate, i.e. a volatile aggregate instance that contains all instances of the specified types in one data model, i.e., the union aggregate is a union of all the ENTITY_EXTENT.INSTANCES aggregates of the specified instance types in the data model.
A numeric aggregateID that uniquely identifies the new created union aggregate instance in the EDMdatabase^ will be the returned function value. This aggregateID should be used to identify this particular union aggregate instance in subsequent EDMinterface^ operations.
The resulting union aggregate instance will not be persistent in the EDMdatabase^, it will exist until it is deleted by the xpxDeleteAggr operation or until the open EDMserver^ session is closed by the function sdaiCloseSession or the current open database is closed.
The resulting union aggregate can only be accessed by read operations. It is not permitted to change the contents of an union aggregate. All read (get) operations available for SET and BAG aggregate types are available for accessing union aggregates.
This operation is only applicable to data models. The actual data model must be open before this operation can be successfully performed.
Note: The creation and deletion of instance types held by an union aggregate will influence the contents of the related union aggregates, hence it is recommended to delete and re-create the related union aggregate after such operations.
This function is equivalent to the EDMinterface^ function edmiCreateUnionAggrBN.