EKM Client API

- Main Page
- Namespaces
- Classes

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

Public Member Functions | Public Attributes
com::ansys::ingress::client::api::search::Query Class Reference

Query represents a complex query that is performed in an EKM repository. More...

List of all members.

## Public Member Functions

| Query ()
| Creates a new instance of Query.
| Query (string objectType)
| Creates a new instance of Query.
QueryRow | CreateQueryRow (string attribute, Condition condition, bool value)
| Creates a query row for a query.
QueryRow | CreateQueryRow (string attribute, Condition condition, DateTime value)
| Creates a query row for a query.
QueryRow | CreateQueryRow (string attribute, Condition condition, double value)
| Creates a query row for a query.
QueryRow | CreateQueryRow (string attribute, Condition condition, long value)
| Creates a query row for a query.
QueryRow | CreateQueryRow (string attribute, Condition condition, string value)
| Creates a query row for a query.
QueryRow | CreateQueryRow (string attribute, Condition condition, List< string > value)
| Creates a query row for a query.
QueryOperation | GetOp ()
| Gets the query operation for this query.
string | GetPath ()
| Gets the path for this queyr.
string | GetQueryType ()
| Gets the type of this query.
string | Serialize ()
| Serializes this query into an XML document.
void | SetOp (QueryOperation op)
| Sets the query operation for this query.
void | SetPath (string path)
| Sets the path for this query.
void | SetQueryType (string type)
| Sets the type of the query.

## Public Attributes

const string | PROPERTY_SEARCH = "advancedSearch.property"
| Constant for creating a query for searching object properties.

## Detailed Description

Query represents a complex query that is performed in an EKM repository.

## Constructor & Destructor Documentation

com::ansys::ingress::client::api::search::Query::Query | ( |  | ) | `[inline]`

Creates a new instance of Query.

com::ansys::ingress::client::api::search::Query::Query | ( | string | objectType | ) | `[inline]`

Creates a new instance of Query.

Parameters:

  objectType | the type of objects to search

## Member Function Documentation

QueryRow com::ansys::ingress::client::api::search::Query::CreateQueryRow | ( | string | attribute,
|  | Condition | condition,
|  | bool | value
| ) |  | `[inline]`

Creates a query row for a query.

Parameters:

  attribute | the attribute to search
  condition | the condition (e.g. ==, !=)
  value | the value to test against

Returns:
  Returns the row for the query.

QueryRow com::ansys::ingress::client::api::search::Query::CreateQueryRow | ( | string | attribute,
|  | Condition | condition,
|  | DateTime | value
| ) |  | `[inline]`

Creates a query row for a query.

Parameters:

  attribute | the attribute to search
  condition | the condition (e.g. ==, !=)
  value | he value to test against

Returns:
  Returns the row for the query.

QueryRow com::ansys::ingress::client::api::search::Query::CreateQueryRow | ( | string | attribute,
|  | Condition | condition,
|  | long | value
| ) |  | `[inline]`

Creates a query row for a query.

Parameters:

  attribute | the attribute to search
  condition | the condition (e.g. ==, !=)
  value | the value to test against

Returns:
  Returns the row for the query.

QueryRow com::ansys::ingress::client::api::search::Query::CreateQueryRow | ( | string | attribute,
|  | Condition | condition,
|  | string | value
| ) |  | `[inline]`

Creates a query row for a query.

Parameters:

  attribute | the attribute to search
  condition | the condition (e.g. ==, !=)
  value | the value to test against

Returns:
  Returns the row for the query.

QueryRow com::ansys::ingress::client::api::search::Query::CreateQueryRow | ( | string | attribute,
|  | Condition | condition,
|  | double | value
| ) |  | `[inline]`

Creates a query row for a query.

Parameters:

  attribute | the attribute to search
  condition | the condition (e.g. ==, !=)
  value | the value to test against

Returns:
  Returns the row for the query.

QueryRow com::ansys::ingress::client::api::search::Query::CreateQueryRow | ( | string | attribute,
|  | Condition | condition,
|  | List< string > | value
| ) |  | `[inline]`

Creates a query row for a query.

Parameters:

  attribute | the attribute to search
  condition | the condition (e.g. ==, !=)
  value | the value to test against

Returns:
  Returns the row for the query.

QueryOperation com::ansys::ingress::client::api::search::Query::GetOp | ( |  | ) | `[inline]`

Gets the query operation for this query.

Returns:
  Returns the query operation.

string com::ansys::ingress::client::api::search::Query::GetPath | ( |  | ) | `[inline]`

Gets the path for this queyr.

Returns:
  Returns the path

string com::ansys::ingress::client::api::search::Query::GetQueryType | ( |  | ) | `[inline]`

Gets the type of this query.

Returns:
  Returns the type.

string com::ansys::ingress::client::api::search::Query::Serialize | ( |  | ) | `[inline]`

Serializes this query into an XML document.

Returns:
  Returns the serialized query.

void com::ansys::ingress::client::api::search::Query::SetOp | ( | QueryOperation | op | ) | `[inline]`

Sets the query operation for this query.

Parameters:

  op | the operation to set

void com::ansys::ingress::client::api::search::Query::SetPath | ( | string | path | ) | `[inline]`

Sets the path for this query.

Parameters:

  path | the path to set

void com::ansys::ingress::client::api::search::Query::SetQueryType | ( | string | type | ) | `[inline]`

Sets the type of the query.

Parameters:

  type | the type to set

## Member Data Documentation

const string com::ansys::ingress::client::api::search::Query::PROPERTY_SEARCH = "advancedSearch.property"

Constant for creating a query for searching object properties.

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

- Query.cs

All Classes Namespaces Functions Variables Enumerations Properties