Class KeywordSearch

Represents an instance of keyword search. Keyword search (or SQL index search) is Relativity's default search engine.

Inheritance
System.Object
Artifact
NamedArtifact
KeywordSearch
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Relativity.Testing.Framework.Models
Assembly: Relativity.Testing.Framework.dll
Syntax
public class KeywordSearch : NamedArtifact, IHasName

Properties

| Improve this Doc View Source

ArtifactTypeID

Gets or sets the Artifact Type ID of the object for the search (currently only Document is supported).

Declaration
public int ArtifactTypeID { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Dashboard

Gets or sets dashboard associated with the saved search.

Declaration
public NamedArtifact Dashboard { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

Fields

Gets or sets the fields to be included in the search result set specified as a collection of Field objects.

Declaration
public NamedArtifact[] Fields { get; set; }
Property Value
Type Description
NamedArtifact[]
| Improve this Doc View Source

Includes

Gets or sets field identifying documents related to the documents matching the search criteria. The related documents will be included in the result set alongside with the documents that match the search criteria.

Declaration
public NamedArtifact Includes { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

Keywords

Gets or sets optional field for recording additional information associated with the search as keywords.

Declaration
public string Keywords { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Notes

Gets or sets detailed description of the saved search.

Declaration
public string Notes { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Owner

Gets or sets user(s) who can access the saved search. Setting the ArtifactID value to 0 enables all users with permissions to the saved search are able to see it.

Declaration
public NamedArtifact Owner { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

QueryHint

Gets or sets string parameter used to optimize views. Only use the query hint if instructed by the kCura Client Services team. Currently, you can use Hashjoin:(true/false) or Maxdrop:(x) to populate the field.

Declaration
public string QueryHint { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RelativityApplications

Gets or sets relativityApplications associated with this saved search.

Declaration
public List<NamedArtifact> RelativityApplications { get; set; }
Property Value
Type Description
System.Collections.Generic.List<NamedArtifact>
| Improve this Doc View Source

RequiresManualRun

Gets or sets a value indicating whether requires users to rerun a saved search when they return to it to ensure up-to-date results.

Declaration
public bool RequiresManualRun { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Scope

Gets or sets the scope of the search specified as a ScopeType enumeration.

Declaration
public ScopeType Scope { get; set; }
Property Value
Type Description
ScopeType
| Improve this Doc View Source

SearchCriteria

Gets or sets search Criteria specified as a CriteriaCollection object.

Declaration
public CriteriaCollection SearchCriteria { get; set; }
Property Value
Type Description
CriteriaCollection
| Improve this Doc View Source

SearchFolders

Gets or sets if folders or subfolders are specified as the KeywordSearch.

Declaration
public List<NamedArtifact> SearchFolders { get; set; }
Property Value
Type Description
System.Collections.Generic.List<NamedArtifact>
| Improve this Doc View Source

SearchIndex

Gets or sets searchIndex of the keyword index used by the search.

Declaration
public NamedArtifact SearchIndex { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

SearchText

Gets or sets search terms.

Declaration
public string SearchText { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SortByRank

Gets or sets a value indicating whether indicates that the search results must be sort by relevance rank.

Declaration
public bool SortByRank { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Sorts

Gets or sets sort order for search results specified as a Sorts object.

Declaration
public List<Sort> Sorts { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Sort>
| Improve this Doc View Source

SystemCreatedBy

Gets or sets artifactID of the user who created the saved search.

Declaration
public NamedArtifact SystemCreatedBy { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

SystemCreatedOn

Gets or sets date and time in UTC when the saved search was created.

Declaration
public DateTime? SystemCreatedOn { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

SystemLastModifiedBy

Gets or sets artifactID of the user who last modified the saved search.

Declaration
public NamedArtifact SystemLastModifiedBy { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

SystemLastModifiedOn

Gets or sets date and time in UTC when the search was last modified.

Declaration
public DateTime? SystemLastModifiedOn { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Methods

| Improve this Doc View Source

FillRequiredProperties()

Fills the Name on the KeywordSearch if its null.

Declaration
public KeywordSearch FillRequiredProperties()
Returns
Type Description
KeywordSearch

A filled KeywordSearch.

Implements