Class: XmlExecuteQuery

tibco.objectapi.common.organisation.XmlExecuteQuery

new XmlExecuteQuery()

Definition of an executable resource query, used to identify a collection of resources that match the criteria specified in the query. Extension of XmlOrgModelVersion, which provides the organization model version in which the resources to be queried reside. Constructs a new XmlExecuteQuery.

The following features are supported:

Extends

Members

implementation :number

Identifies the implementation version, and governs what style of response will be generated. This allows for the XML schema of the response to vary but remain backward compatible. This property holds the value of the 'Implementation' attribute.
Type:
  • number

modelVersion :number

Major version number of the organization model in which an organization model entity resides. If not specified, the default value will be the latest version of the organization model. (Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.) This property holds the value of the 'Model Version' attribute.
Type:
  • number
Inherited From:

query :string

Resource query to be executed. The query must conform to the Resource Query Language (RQL) specification. See the product documentation for detailed information about RQL syntax. This property holds the value of the 'Query' attribute.
Type:
  • string
Inherited From:

singleRandomResult :boolean

Boolean value specifying whether the query should return a single, randomly selected user from the result set (TRUE), or all the resources in the result set (FALSE). This property holds the value of the 'Single Random Result' attribute.
Type:
  • boolean