ISearchContainerManager Interface

Relativity Services API
Search Container Manager.

Namespace:  Relativity.Services.Search
Assembly:  Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public interface ISearchContainerManager : IDisposable

The ISearchContainerManager type exposes the following members.

Methods

  NameDescription
Public methodCreateSingleAsync
Asynchronously creates an instance of Search Container.
Public methodDeleteSingleAsync
Asynchronously delets a Search Container and its children.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodGetAdvancedSearchViewInfoAsync
Asynchronously gets the fields of Advanced Search browser View, if user has read permissions for view.
Public methodGetAdvancedSearchViewUniqueCreatedByAsync
Asynchronously gets the users that have created at least one of saved searches in workspace.
Public methodGetAdvancedSearchViewUniqueModifiedByAsync
Asynchronously gets the users that have modified at least one of saved searches in workspace.
Public methodGetAdvancedSearchViewUniqueOwnersAsync
Asynchronously gets the users that are owners of at least one of saved searches in workspace.
Public methodGetChildSearchContainersAsync
Asynchronously gets child Search Containers without search items.
Public methodGetFilteredSearchContainerTreeAsync
Asynchronously gets the tree of search containers and saved searches matching the search condition specified as a query string.
Public methodGetFilteredWithAdvancedOptionsSearchContainerTreeAsync
Asynchronously gets the tree of search containers and saved searches matching the search condition specified as a SearchContainerTreeFilter object.
Public methodGetSearchContainerItemsAsync
Asynchronously get items stored within a Search Container.
Public methodGetSearchContainerTreeAsync(Int32, List<Int32>)
Asynchronously gets tree of Search Containers and Saved Searches with specified nodes expanded.
Public methodGetSearchContainerTreeAsync(Int32, List<Int32>, Nullable<Int32>)
Asynchronously gets tree of Search Containers and Saved Searches with specified nodes expanded, auto-expanding full path to the selected node.
Public methodMoveAsync(Int32, Int32, Int32)
Moves an existing saved search folder (search container) and its children, including subfolders and saved searches. Specify the workspace, source folder, and destination folder by Artifact ID.
Public methodMoveAsync(Int32, Int32, Int32, IProgress<MoveProcessStateProgress>)
Moves an existing saved search folder (search container) and its children, including subfolders and saved searches. Specify the workspace, source folder, and destination folder by Artifact ID. Specify the MoveProgressState object to display the progress of the operation.
Public methodMoveAsync(Int32, Int32, Int32, CancellationToken)
Moves an existing saved search folder (search container) and its children, including subfolders and saved searches. Specify the workspace, source folder, and destination folder by Artifact ID. Specify the CancellationToken object to enable cancellation.
Public methodMoveAsync(Int32, Int32, Int32, CancellationToken, IProgress<MoveProcessStateProgress>)
Moves an existing saved search folder (search container) and its children, including subfolders and saved searches. Specify the workspace, source folder, and destination folder by Artifact ID. Specify the MoveProgressState and CancellationToken objects to display progress and enable cancellation.
Public methodQueryAsync(Int32, Query)
Asynchronously queries for Search Containers.
Public methodQueryAsync(Int32, Query, Int32)
Asynchronously queries for Search Containers.
Public methodQuerySubsetAsync
Asynchronously queries for a subset of a collection of Search Container instances.
Public methodReadSingleAsync
Asynchronously read a single Search Container instance.
Public methodUpdateSingleAsync
Asynchronously updates a Search Container.
Top
See Also

Reference