Page Comparison

serverContextId

Context identification, from edmiDefineServerContext

remoteRepositoryName

Specifies the name of the remote edmRepository that contains the edmModel. Repository names are case sensitive.

remoteModelName

Specifies the name of the remote edmModel that contains the instances to query. Model names are case sensitive.

entityName

Specifies the name of the entity. Entity names are case insensitive. Use the option SUBTYPES to include all subtypes of this entity.

condition

The condition that the instances in the instance aggregate shall match. A NULL or empty string condition will match all the instances in the aggregate.  A valid condition is any Express-X logical expression that refers to any number of attributes defined for the instance type specified by the argument <entityName>. The expression may also refer to attributes of referenced application instances.
Example conditions:
"xpxTRUETRUE"
Equivalent to NULL or empty string.
"(NAME LIKE 'JOHN*') AND (AGE > 30)"
Matches Johnny and Johnatan Jonathan if they are older than 30 years.
"WIFE.MOTHER.DOG.NAME = 'Fido'"
Matches all men with a mother in law that owns a dog named Fido.

options

See description of available options below.  Options may be joined by using the bitwise OR operator

attributes

Specification of the title and contents of each column of the returned query result table. The following examples illustrate the syntax.
"NAME SEX AGE" :
The attributes name, sex and age will be returned in column 1, 2 and 3 of the returned query table. The title of the columns will be NAME, SEX and AGE respectively.
"NAME,WIFE.MOTHER.DOG.NAME->DOG"
The first column will contain the mans name. The second column will contain the mans mother in laws dogs name. The title of the columns will be NAME and DOG respectively.
"DOG.NAME->DOG;xpfGetMemberCount(DOG. PUPPIES)->PUPPIES"
The first column will contain the dogs name. The second column will contain its number of puppies . The title of the columns will be DOG and PUPPIES respectively.  Whitespace, comma end semicolon are all used as field delimiters.

include_exclude_filter

A zero-terminated buffer of entityIds or a NULL-terminated buffer of string pointers to entity names. This argument is only applicable when the option SUBTYPES is used.

• If the option FILTER_AS_ENTITY_IDS is used, this parameter will be interpreted as a buffer of entityIds of subtypes of the entity given in the argument <entityName>.
• If the option FILTER_AS_ENTITY_NAMES is used, this parameter will be interpreted as a buffer of strings containing the names of subtypes of the entity given in the argument <entityName>.
• If the option INCLUDE_FILTER is used, no subtypes but those listed by this argument will be included.
• If the option EXCLUDE_FILTER is used, all subtypes but those listed by this argument will be included.

orderBy

Name of the query result column to use for sorting. The column may be specified with its constructor or by the column title.  If the <attributes> argument is:
"DOG.NAME->DOG"
The order by argument may be either "DOG" or "DOG.NAME".  This argument is only applicable when one of the options HTML_FORMAT or ASCII_FORMAT is used. Use the options ASCENDING and DESCENDING to specify the sorting direction.

index

• In: The index of the element in the instance aggregate to start searching from. The first element in the instance aggregate is indexed zero. Hence the legal index range is: [ 0 <= index < N ] , where N is the number of instances in the instance aggregate.
• Out: The index of the "last returned matching element". If the return value is incremented by one, it may be used as input value for a succeeding call to the same function. This way, the second call will start reading instances where the first call finished.

numberOfHits

• In: Specifies the maximum number of matching instances to return.
• Out: The number of matching instances found.

queryResult

A variable that will receive the result of the query. 

xmlConfigurationName

The name of the XML configuration to apply to the resulting XML formatted query result when the option XML_FORMAT is used.

resultString

Variable that will receive the returned XML, HTML or ASCII formatted query result when the option RESULT_IN_STRING is used with one of the options HTML_FORMAT, ASCII_FORMAT or XML_FORMAT.

resultFileName

The name of the file that will contain the returned XML, HTML or ASCII formatted query result. Only applicable when using the RESULT_IN_FILE option in combination with one of the options HTML_FORMAT, ASCII_FORMAT or XML_FORMAT.
Use the ZIPPED_FILE option to compress the generated file.

edmiInvocationId

Currently not used.