Relativity.Testing.Framework.Api.Services.IMatterService

IMatterService

public interface IMatterService

Represents the matter API service.

Documentation

Creates the specified [Matter](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Matter.html).

void Delete(int id)

Deletes the [Matter](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Matter.html) by ArtifactID.

Matter Get(int id, bool withExtendedMetadata = false)

Gets the [Matter](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Matter.html) by the ArtifactID.

Matter Get(string name, int clientId)

Gets the [Matter](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Matter.html) by the matter name, and Client ArtifactID.

ArtifactIdNamePair[] GetEligibleClients()

Gets all of available clients in a Relativity environment.

ArtifactIdNamePair[] GetEligibleStatuses()

Gets all of available matter statuses in a Relativity environment.

Matter Require(Matter entity)

Requires the specified matter. If the [ArtifactID](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Artifact.html#Relativity_Testing_Framework_Models_Artifact_ArtifactID) property of entity has a positive value, this gets the matter by ID and updates it.Else if the [Name](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.NamedArtifact.html#Relativity_Testing_Framework_Models_NamedArtifact_Name) property of entity have a value, this gets the matter by name and client ID and updates it, if it exists.Otherwise this creates a new matter using ICreateWorkspaceEntityStrategy<T>.

void Update(Matter entity, bool restrictedUpdate = false)

Updates the specified [Matter](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Matter.html).