xpfGetHashedAttrInstancesEx

FUNCTION xpfGetHashedAttrInstancesEx (modelId               : GENERIC;
                                      entityId              : GENERIC;
                                      attrId                : GENERIC;
                                      attrValue             : STRING;
                                      index                 : INTEGER;
                                      maxHits               : INTEGER;
                                      VAR indexOfLastFound  : INTEGER)
                                      matchingInstances     : SET OF GENERIC;

Function to search an given EDMpersitentAttrHashTable for one or more elements (instanceIds) that matches a specified string value. This function has variable number of arguments, i.e., it can be invoked with minimum 4 argument and maximum 7 arguments.

By intoducing the xpxDefinePersistentAttrHashTableBNEx() function, it is possible to have more than one EDMpersitentAttrHashTable for the same attribute in the same model. The functions xpfGetHashedAttrInstance(), xpxGetHashedAttrInstances(), xpfGetHashedAttrInstances() will not disinguish between different EDMpersitentAttrHashTables for the same attribute, since only the model and the attribute are used for identifying the actual EDMpersitentAttrHashTable. The functions xpfGetHashedAttrInstanceEx() and xpfGetHashedAttrInstancesEx() uses the combination of model, entity and attribute to identify an EDMpersitentAttrHashTable, i.e., these function can also disinguish between different EDMpersitentAttrHashTables for the same attribute in a model.

Arguments

1	Type	Name	Comment
2	GENERIC	modelId	Specifies the EDMdataModel to search in. The combination of the arguments "modelId", "entityId" and "attrId" uniquely identifies an EDMpersitentAttrHashTable in an EDMdatabase.
3	GENERIC	entityId	An enityId that is part of the actual EDMpersitentAttrHashTable identification
4	GENERIC	attrId	An attributeId that is part of the actual EDMpersitentAttrHashTable identification
5	STRING	attrValue	Specifies the actual string value to search for in the given EDMpersitentAttrHashTable.
6	INTEGER	index	Optional argument. Default value is "index = 1", i.e., specifies that the first element to be returned is the first matching element. When specified, it defines the index of the first matching element to be returned. The index of the "last matching element" is returned in the "indexOfLastFound" argument when the xpfGetHashedAttrInstancesEx() operation is terminated. This functionality enables the possibility to perform a search in an iterative way, i.e., the xpfGetHashedAttrInstancesEx() function can be called in a loop using the returned "indexOfLastFound + 1" value from one invocation as the input "index" value in the next invocation.
7	INTEGER	maxHits	Optional argument. Default value is INDETERMINATE (?) meaning there will be no "maxHits" limit, i.e., the search will continue until all matching instances are found.
8	INTEGER	indexOfLastFound	Optional argument. When specified the index of the last returned matching element will be returned in thios argument.

Return Value

Type	Name	Comment
SET OF GENERIC	matchingInstances	When the xpfGetHashedAttrInstancesEx() operation is successfully performed, a SET aggregate with instanceIds that matches the specified string value will be returned. When no matching instances is founs, an empty SET aggregate is returned. The value INDETERMINATE (?) will be returned when the xpfGetHashedAttrInstancesEx() operation fails. Exception handling should be used to handle error conditions in the actual xpfGetHashedAttrInstancesEx() operation.

Options

Example

<Missing Example>

xpfGetHashedAttrInstancesEx

Arguments

Return Value

Options

Example

See also

Filter by label