Describes a query or search of the Relativity workspace. It is passed into the Query method.
Inheritance Hierarchy
kCura.Relativity.Client.Query
Namespace: kCura.Relativity.Client
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The Query type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | Query() |
Initializes a new instance of the Query class.
|
![]() | Query(List<Field>, Condition, List<Sort>) |
Initializes a new instance of the Query class.
|
Properties
Name | Description | |
---|---|---|
![]() | ArtifactTypeGuid |
Indicates the GUID for the type of an item to query on. Use as an alternative to specifying either the ArtifactTypeID or ArtifactTypeName.
|
![]() | ArtifactTypeID |
Indicates the identifier for the object to query on. ArtifactType Enumeration contains these identifiers. Use as an alternative to ArtifactTypeName or ArtifactTypeGuid.
|
![]() | ArtifactTypeName |
Indicates the name of the Artifact type to query on. Use as an alternative to ArtifactTypeID.
|
![]() | Condition |
Provides search criteria. It can be a simple, single-field condition, or a complex expression combining multiple conditions.
|
![]() | Fields |
Provides a collection of Field objects that should be returned by the query.
|
![]() | QueryHint |
Gets or sets the QueryHint of the currently executing search.
|
![]() | RelationalField |
Identifies the Relational field used when searching.
|
![]() | RowCondition |
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.
|
![]() | SampleParameters |
Contains the necessary parameters to execute a Search Provider search.
|
![]() | SearchProviderCondition |
Contains the necessary parameters to execute a Search Provider search.
|
![]() | Sorts |
Provides a list of Sort objects indicate how the results are organized.
|
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also