Represents an instance of keyword search. Keyword search (or SQL index search) is Relativity's default search engine.
Inheritance Hierarchy
Relativity.Services.Search.SavedSearchRef
Relativity.Services.Search.KeywordSearch
Namespace: Relativity.Services.Search
Assembly: Relativity.Services.DataContracts (in Relativity.Services.DataContracts.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
public class KeywordSearch : SavedSearchRef, ISavedSearch, IRelativityApplicationAssociable
The KeywordSearch type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | KeywordSearch |
KeywordSearch constructor.
|
Properties
| Name | Description | |
|---|---|---|
 | ArtifactID |
ArtifactID of the saved search.
(Inherited from SavedSearchRef.) |
| ArtifactTypeID |
The Artifact Type ID of the object for the search (currently only Document is supported).
|
| Dashboard |
Dashboard associated with the saved search.
|
| Fields |
The fields to be included in the search result set specified as a collection of Field objects.
|
| Includes |
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.
|
| Keywords |
Optional field for recording additional information associated with the search as keywords.
|
| Name |
Descriptive name of the saved search.
(Inherited from SavedSearchRef.) |
| Notes |
Detailed description of the saved search.
|
| Owner |
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.
|
| QueryHint |
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.
|
| RelativityApplications |
RelativityApplications associated with this saved search.
|
| RequiresManualRun |
Requires users to rerun a saved search when they return to it to ensure up-to-date results.
|
| Scope |
The scope of the search specified as a ScopeType enumeration.
|
| SearchContainer |
SearchContainer of the saved search folder. If no value is specified, the search will be saved at the logical root of the saved search view.
|
| SearchCriteria |
Search Criteria specified as a CriteriaCollection object.
|
| SearchFolders |
If folders or subfolders are specified as the KeywordSearch.
|
| SearchIndex |
SearchIndex of the keyword index used by the search.
|
| SearchText |
Search terms.
|
| SearchType |
Type of the saved search.
(Inherited from SavedSearchRef.) |
| SortByRank |
Indicates that the search results must be sort by relevance rank.
|
| Sorts |
Sort order for search results specified as a Sorts object.
|
| SystemCreatedBy |
ArtifactID of the user who created the saved search.
|
| SystemCreatedOn |
Date and time in UTC when the saved search was created.
|
| SystemLastModifiedBy |
ArtifactID of the user who last modified the saved search.
|
| SystemLastModifiedOn |
Date and time in UTC when the search was last modified.
|
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.) |
| GetSearchType |
Return the object type corresponding to the SearchType string.
(Inherited from SavedSearchRef.) |
| 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