EKM Client API

- Main Page
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
com::ansys::ingress::client::api::search::QueryOperation Class Reference

QueryOperation is the data used to query for objects on the EKM server. More...

List of all members.

## Public Member Functions

void | AddRow (QueryRow row)
| Adds a row to this operation.
void | AddSubExpression (QueryOperation subExpression)
| Adds a subexpression to this operation.
bool | AllowsChildBasedSearch ()
| Determines if this query allows child-based searches.
bool | AllowsSubExpressionSearch ()
| Determines if this query allows subexpressions.
QueryMatch | GetMatch ()
| Gets how query rows are matched in this query (either ALL or ANY).
List< QueryRow > | GetRows ()
| Gets the rows of this query.
List< QueryOperation > | GetSubExpressions ()
| Gets the sub-expressions for this query if sub-expression searches are allowed.
void | SetAllowChildBasedSearch (bool allowChildBasedSearch)
| Sets whether child based searches are allowed.
void | SetAllowSubExpressionSearch (bool allowSubExpressionSearch)
| Sets whether sub-expressions are allowed.
void | SetMatch (QueryMatch match)
| Sets how rows in the query are matched (i.e. ALL or ANY).
void | SetRows (List< QueryRow > rows)
| Sets the rows of the query.
void | SetSubExpressions (List< QueryOperation > subExpressions)
| Sets the sub-expressions of the query. For these sub-expressions to be used, you must invoke SetAllowSubExpressionSearch(true) before executing the query.

## Detailed Description

QueryOperation is the data used to query for objects on the EKM server.

## Member Function Documentation

void com::ansys::ingress::client::api::search::QueryOperation::AddRow | ( | QueryRow | row | ) | `[inline]`

Adds a row to this operation.

Parameters:

  row | the row to add

void com::ansys::ingress::client::api::search::QueryOperation::AddSubExpression | ( | QueryOperation | subExpression | ) | `[inline]`

Adds a subexpression to this operation.

Parameters:

  subExpression | the expression to add

bool com::ansys::ingress::client::api::search::QueryOperation::AllowsChildBasedSearch | ( |  | ) | `[inline]`

Determines if this query allows child-based searches.

Returns:
  Returns true if this query allows child-based searches.

bool com::ansys::ingress::client::api::search::QueryOperation::AllowsSubExpressionSearch | ( |  | ) | `[inline]`

Determines if this query allows subexpressions.

Returns:
  Returns true if this query allows subexpressions.

QueryMatch com::ansys::ingress::client::api::search::QueryOperation::GetMatch | ( |  | ) | `[inline]`

Gets how query rows are matched in this query (either ALL or ANY).

Returns:
  Returns the match value.

List<QueryRow> com::ansys::ingress::client::api::search::QueryOperation::GetRows | ( |  | ) | `[inline]`

Gets the rows of this query.

Returns:
  Returns the rows. Guaranteed to not be null.

List<QueryOperation> com::ansys::ingress::client::api::search::QueryOperation::GetSubExpressions | ( |  | ) | `[inline]`

Gets the sub-expressions for this query if sub-expression searches are allowed.

Returns:
  Returns the sub-expressions. May be null if sub-expression searches are not allowed.

void com::ansys::ingress::client::api::search::QueryOperation::SetAllowChildBasedSearch | ( | bool | allowChildBasedSearch | ) | `[inline]`

Sets whether child based searches are allowed.

Parameters:

  allowChildBasedSearch | the value to set

void com::ansys::ingress::client::api::search::QueryOperation::SetAllowSubExpressionSearch | ( | bool | allowSubExpressionSearch | ) | `[inline]`

Sets whether sub-expressions are allowed.

Parameters:

  allowSubExpressionSearch | the value to set

void com::ansys::ingress::client::api::search::QueryOperation::SetMatch | ( | QueryMatch | match | ) | `[inline]`

Sets how rows in the query are matched (i.e. ALL or ANY).

Parameters:

  match | the value to set

void com::ansys::ingress::client::api::search::QueryOperation::SetRows | ( | List< QueryRow > | rows | ) | `[inline]`

Sets the rows of the query.

Parameters:

  rows | the rows to set

void com::ansys::ingress::client::api::search::QueryOperation::SetSubExpressions | ( | List< QueryOperation > | subExpressions | ) | `[inline]`

Sets the sub-expressions of the query. For these sub-expressions to be used, you must invoke SetAllowSubExpressionSearch(true) before executing the query.

Parameters:

  subExpressions | the value to set

The documentation for this class was generated from the following file:

- QueryOperation.cs

All Classes Namespaces Functions Variables Enumerations Properties