Relativity.Services.Search.IdtSearchManager

public interface IdtSearchManager : IDisposable

IdtSearchManager interface enables interaction with Relativity dtSearch.

Documentation

Task<SavedSearchRef> CopySingleAsync(int workspaceArtifactID, int searchArtifactID)

Asynchronously copies an instance of dtSearch saved search.

Task<int> CreateSingleAsync(int workspaceArtifactID, dtSearch searchDTO)

Asynchronously creates an instance of saved dtSearch in a workspace.

Task DeleteSingleAsync(int workspaceArtifactID, int searchArtifactID)

Asyncronously deletes an instance of saved dtSearch.

Task<SearchAccessStatus> GetAccessStatusAsync(int workspaceArtifactID, int artifactID, List<int> ancestorArtifactIDs)

Asynchronously gets information about user's ability to access the saved search.

Task<WordListDictionaryResponse> GetDictionarySearchResultsAsync(int workspaceArtifactID, int searchProviderID, string searchRequest, string fuzzinessLevel, bool enableStemming, IEnumerable<WordListFieldCondition> conditions, WordListSort sort, int start, int length)

Asynchronously returns the dictionary search results matching the search.

Task<string> GetEmailToLinkUrlAsync(int workspaceArtifactID, int searchArtifactID)

Asychronously returns the email link to a specified saved dtSearch.

Task<List<FieldRef>> GetFieldsForCriteriaConditionAsync(int workspaceArtifactID, int artifactTypeID)

Asychronously returns all workspace fields available to the user that can be included in a saved search condition.

Task<List<FieldRef>> GetFieldsForObjectCriteriaCollectionAsync(int workspaceArtifactID, FieldRef field, int artifactTypeID)

Asychronously returns all workspace fields available to the user that can be specified as a subcondition for a given field in a saved search condition. Use to populate field values for batch and multi-object conditions.

Task<SearchResultViewFields> GetFieldsForSearchResultViewAsync(int workspaceArtifactID, int artifactTypeID)

Asychronously returns all workspace fields available to the user as the SearchResultViewFields.FieldsNotIncluded property. Use to populate the dtSearch.Fields property.

Task<SearchResultViewFields> GetFieldsForSearchResultViewAsync(int workspaceArtifactID, int artifactTypeID, int searchArtifactID)

Asychronously returns all fields included in the search as SearchResultViewFields.FieldsIncluded property. Use to populate the dtSearch.Fields property.

Task<List<int>> GetReferencedSavedSearchesAsync(int workspaceArtifactID, int searchArtifactID)

Asychronously returns all referenced saved search artifact id's for a given saved search.

Task<List<FieldRef>> GetSearchIncludesAsync(int workspaceArtifactID)

Asychronously returns all relational fields available to the user in the workspace. Use to populate the dtSearch.Includes property.

Task<List<SearchIndexRef>> GetSearchIndexesAsync(int workspaceArtifactID)

Asychronously returns all dtSearch indexes available to the user in the workspace. Use to populate the dtSearch.SearchIndexID property.

Task<List<UserRef>> GetSearchOwnersAsync(int workspaceArtifactID)

Asychronously returns all users in the workspace with permissions to view saved searches. Use to populate the dtSearch.Owners property.

Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID)

Moves an existing dtSearch. Specify the workspace, search, and destination folder by Artifact ID.

Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel)

Moves an existing dtSearch. Specify the workspace, search, and destination folder by Artifact ID. Specify the CancellationToken object to enable cancellation.

Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, IProgress<MoveProcessStateProgress> progress)

Moves an existing dtSearch. Specify the workspace, search, and destination folder by Artifact ID. Specify the MoveProgressState object to display the progress of the operation.

Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel, IProgress<MoveProcessStateProgress> progress)

Moves an existing dtSearch. Specify the workspace, search, and destination folder by Artifact ID. Specify the MoveProgressState and CancellationToken objects to display progress enable cancellation.

Task<dtSearchQueryResultSet> QueryAsync(int workspaceArtifactID, Query query)

Returns a result set of saved dtSearch objects matching the specified query.

Task<dtSearchQueryResultSet> QueryAsync(int workspaceArtifactID, Query query, int length)

Returns a result set of saved dtSearch objects matching the specified query.

Task<dtSearchQueryResultSet> QuerySubsetAsync(int workspaceArtifactID, string queryToken, int start, int length)

Returns a subset of a result set of analytics objects matching the specified query token.

Task<dtSearch> ReadSingleAsync(int workspaceArtifactID, int searchArtifactID)

Asynchronously returns an instance of a saved dtSearch as a dtSearch object.

Task UpdateSingleAsync(int workspaceArtifactID, dtSearch searchDTO)

Asynchronously updates an instance of a saved dtSearch.