Skip To Content ArcGIS for Developers Sign In Dashboard

RelatedQueryParameters Class

(Esri::ArcGISRuntime::RelatedQueryParameters)

Contains the input parameters for a related tables query. More...

Header: #include <RelatedQueryParameters>
Since: Esri::ArcGISRuntime 100.1

Public Functions

RelatedQueryParameters()
RelatedQueryParameters(const RelationshipInfo &relationshipInfo)
RelatedQueryParameters(const RelatedQueryParameters &other)
RelatedQueryParameters(RelatedQueryParameters &&other)
~RelatedQueryParameters()
void clear()
bool isEmpty() const
bool isReturnGeometry() const
int maxFeatures() const
QList<OrderBy> orderByFields() const
RelationshipInfo relationshipInfo() const
int resultOffset() const
void setMaxFeatures(int maxFeatures)
void setOrderByFields(const QList<OrderBy> &orderByFields)
void setRelationshipInfo(const RelationshipInfo &relationshipInfo)
void setResultOffset(int resultOffset)
void setReturnGeometry(bool returnGeometry)
void setWhereClause(const QString &whereClause)
QString whereClause() const
RelatedQueryParameters &operator=(const RelatedQueryParameters &other)
RelatedQueryParameters &operator=(RelatedQueryParameters &&other)

Detailed Description

Contains the input parameters for a related tables query.

Instances of this class represent the query parameters to perform a related query operation. A prerequisite for querying related features is that all the participating tables must be part of a map, as either feature layers or non-spatial tables.

RelatedQueryParameters lets you specify details about the related query to perform and how to return the result, including:

  • Details about the relationship to be queried.
  • A whereClause used to filter features from the related table.
  • How to sort the results.
  • Whether to return geometry within the results.

Member Function Documentation

RelatedQueryParameters::RelatedQueryParameters()

Default Constructor. Create an empty RelatedQueryParameters instance.

RelatedQueryParameters::RelatedQueryParameters(const RelationshipInfo &relationshipInfo)

Constructs a RelatedQueryParameters from relationshipInfo.

RelatedQueryParameters::RelatedQueryParameters(const RelatedQueryParameters &other)

Copy constructor from other RelatedQueryParameters.

RelatedQueryParameters::RelatedQueryParameters(RelatedQueryParameters &&other)

Move constructor from other RelatedQueryParameters.

RelatedQueryParameters::~RelatedQueryParameters()

Destructor

void RelatedQueryParameters::clear()

Clears this RelatedQueryParameters, setting it to empty.

bool RelatedQueryParameters::isEmpty() const

Returns whether this RelatedQueryParameters is empty.

bool RelatedQueryParameters::isReturnGeometry() const

Returns whether geometries are returned in the related feature query result.

Default value is true.

int RelatedQueryParameters::maxFeatures() const

Returns the maximum number of features the query should return.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also setMaxFeatures().

QList<OrderBy> RelatedQueryParameters::orderByFields() const

Returns the list of OrderBy objects which indicate how to sort the results.

See also setOrderByFields() and OrderBy.

RelationshipInfo RelatedQueryParameters::relationshipInfo() const

Returns the RelationshipInfo used to define the tables to use for this query.

See also setRelationshipInfo().

int RelatedQueryParameters::resultOffset() const

Returns the starting offset of results to fetch in the query.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also setResultOffset().

void RelatedQueryParameters::setMaxFeatures(int maxFeatures)

Sets the maximum number of features to be included in the result to maxFeatures.

If 0, then there is no limit set on the number of features.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also maxFeatures().

void RelatedQueryParameters::setOrderByFields(const QList<OrderBy> &orderByFields)

Sets the list of OrderBy objects which indicate how to sort the results to orderByFields.

Results can be sorted on one or more fields. Each OrderBy instance includes a field name and whether to sort by that field in ascending or descending order.

See also orderByFields() and OrderBy.

void RelatedQueryParameters::setRelationshipInfo(const RelationshipInfo &relationshipInfo)

Sets the RelationshipInfo used to define the tables to use for this query to relationshipInfo.

See also relationshipInfo().

void RelatedQueryParameters::setResultOffset(int resultOffset)

Sets the starting offset of results to fetch in the query to resultOffset.

When providing a result offset to support paging of results, you must also set a maximum features value. If the result offset is set, but the maximum features value is not, the offset is ignored. For consistent ordering of the results when using pagination, the order by fields must be set using setOrderByFields.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also resultOffset().

void RelatedQueryParameters::setReturnGeometry(bool returnGeometry)

Sets whether geometries will be returned in the related feature query result to returnGeometry.

Set to true to return related feature geometries.

See also isReturnGeometry().

void RelatedQueryParameters::setWhereClause(const QString &whereClause)

Sets the whereClause to apply to the related table to whereClause.

See also whereClause().

QString RelatedQueryParameters::whereClause() const

Returns the whereClause to apply to the related table.

See also setWhereClause().

RelatedQueryParameters &RelatedQueryParameters::operator=(const RelatedQueryParameters &other)

Assignment operator from other RelatedQueryParameters.

RelatedQueryParameters &RelatedQueryParameters::operator=(RelatedQueryParameters &&other)

Move operator from other RelatedQueryParameters.


Feedback on this topic?