Query Class

Relativity Services API
Describes a query or search of the Relativity workspace. It is passed into the Query method.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.Query

Namespace:  kCura.Relativity.Client
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class Query

The Query type exposes the following members.

Constructors

  NameDescription
Public methodQuery()
Initializes a new instance of the Query class.
Public methodQuery(List<Field>, Condition, List<Sort>)
Initializes a new instance of the Query class.
Top
Properties

  NameDescription
Public propertyArtifactTypeGuid
Indicates the GUID for the type of an item to query on. Use as an alternative to specifying either the ArtifactTypeID or ArtifactTypeName.
Public propertyArtifactTypeID
Indicates the identifier for the object to query on. ArtifactType Enumeration contains these identifiers. Use as an alternative to ArtifactTypeName or ArtifactTypeGuid.
Public propertyArtifactTypeName
Indicates the name of the Artifact type to query on. Use as an alternative to ArtifactTypeID.
Public propertyCondition
Provides search criteria. It can be a simple, single-field condition, or a complex expression combining multiple conditions.
Public propertyFields
Provides a collection of Field objects that should be returned by the query.
Public propertyQueryHint
Gets or sets the QueryHint of the currently executing search.
Public propertyRelationalField
Identifies the Relational field used when searching.
Public propertyRowCondition
Provides row search criteria. It can be a simple, single-field condition, or a complex expression combining multiple conditions. This criteria will limit the result set returned after applying all other conditions and including the relational field. Currently, this property will only work for the Pivot and Object Query APIs.
Public propertySampleParameters
Contains the necessary parameters to execute a Search Provider search.
Public propertySearchProviderCondition
Contains the necessary parameters to execute a Search Provider search.
Public propertySorts
Provides a list of Sort objects indicate how the results are organized.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference