Relativity.Services.ObjectQuery.Query

Query

public class Query

Describes conditions, sorts and fields to be returned for an ObjectQueryManager.Query call

Documentation

public int? ActiveArtifactId { get; set; }

Result page criterion to override start position if available in query results.

public string Condition { get; set; }

Gets or sets the search critera. This can be a simple, single-field condition or a more complex criteria expression by combining conditions together.

public bool? ConvertNumberFieldValuesToString { get; set; }

public int? ExecutingSavedSearchId { get; set; }

ID of the currently executing saved search.

public int? ExecutingViewId { get; set; }

ID of the currently executing view.

public string[] Fields { get; set; }

Fields to be included in the query results.

public bool? IncludeIdWindow { get; set; }

public bool? IsAdHocQuery { get; set; }

Determines whether or not the query is to be run as a built in saved search query or an ad hoc query.

public string QueryHint { get; set; }

Gets or sets the QueryHint of the currently executing search. It is used to optimize the view.

public string RankSortOrder { get; set; }

Sorting direction ASC or DESC of the Rank column

public string RelationalField { get; set; }

Represents a string identifying a relational field. A query containing a relational field returns any matching fields and all documents that share this field.

public string RowCondition { get; set; }

Gets or sets the row condition criteria. This can be a simple, single-field condition or a more complex criteria expression by combining conditions together. This criteria will limit the result set returned after applying all other conditions and including the relational field.

public SampleParameters SampleParameters { get; set; }

public SearchProviderCondition SearchProviderCondition { get; set; }

Contains the necessary parameters to execute a Search Provider search.

public string[] Sorts { get; set; }

Represents an array of fields. You indicate the sort order by specifying ASC or DESC after the field name, such as Relativity Text Identifier ASC. By default, ASC is the sort order on a field.

public bool? TruncateTextFields { get; set; }

public Query()