Interface IImagingSetService

Represents the Imaging Set API service.

Namespace: Relativity.Testing.Framework.Api.Services

Assembly: Relativity.Testing.Framework.Api.dll

Syntax

public interface IImagingSetService

Examples

_imagingSetService = relativityFacade.Resolve<IImagingSetService>();

Methods

Create(Int32, ImagingSetRequest)

Creates imaging set based on provided ImagingSetRequest properties.

Declaration

ImagingSet Create(int workspaceId, ImagingSetRequest imagingSetRequest)

Parameters

Type	Name	Description
System.Int32	workspaceId	The Artifact ID of the workspace that contains the imaging set.
ImagingSetRequest	imagingSetRequest	The Imaging Set Request that included basing information about the Imaging Set that should be created.

Returns

Type	Description
ImagingSet	The created ImagingSet.

Examples

int workspaceId = 1015427;
KeywordSearch keywordSearch = Facade.Resolve<ICreateWorkspaceEntityStrategy<KeywordSearch>>()
	.Create(workspaceId, new KeywordSearch());
var imagingProfileDto = new CreateBasicImagingProfileDTO
{
	Name = Randomizer.GetString(),
	Notes = string.Empty,
	Keywords = string.Empty,
	BasicOptions = new BasicImagingEngineOptions
	{
		ImageOutputDpi = 300,
		BasicImageFormat = ImageFormatType.Jpeg,
		ImageSize = ImageSizeType.Custom,
		MaximumImageHeight = 6.0m,
		MaximumImageWidth = 6.0m
	}
};
ImagingProfile imagingProfile = Facade.Resolve<IImagingProfileCreateBasicStrategy>()
	.Create(workspaceId, imagingProfileDto);

var imagingSetCreateRequest = new ImagingSetRequest
{
	DataSourceID = keywordSearch.ArtifactID,
	ImagingProfileID = imagingProfile.ArtifactID,
	Name = "Test Imaging Set"
};
ImagingSet createdImagingSet = _imagingSetService.Create(workspaceId, imagingSetCreateRequest);

Delete(Int32, Int32)

Deletes Imaging Set.

Declaration

void Delete(int workspaceId, int imagingSetId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The Artifact ID of the workspace that contains the imaging set.
System.Int32	imagingSetId	The Artifact ID of a imaging set.

Examples

int workspaceId = 1015427;
int imagingSetId = 2;
_imagingSetService.Delete(workspaceId, imagingSetId);

Get(Int32, Int32)

Gets the imaging set by specified imagingSetId.

Declaration

ImagingSet Get(int workspaceId, int imagingSetId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The Artifact ID of the workspace that contains the imaging set.
System.Int32	imagingSetId	The Artifact ID of a imaging set.

Returns

Type	Description
ImagingSet	The ImagingSet with specified imagingSetId.

Examples

int workspaceId = 1015427;
int imagingSetId = 2;
ImagingSet imagingSet = _imagingSetService.Get(workspaceId, imagingSetId);

GetStatus(Int32, Int32)

Gets the status of an imaging set.

Declaration

ImagingSetDetailedStatus GetStatus(int workspaceId, int imagingSetId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The Artifact ID of the workspace that contains the imaging set.
System.Int32	imagingSetId	The Artifact ID of a imaging set.

Returns

Type	Description
ImagingSetDetailedStatus	The ImagingSetDetailedStatus repesenting the status of imaging set.

Examples

int workspaceId = 1015427;
int imagingSetId = 2;
ImagingSetDetailedStatus imagingSetStatus = _imagingSetService.GetStatus(workspaceId, imagingSetId);

Hide(Int32, Int32)

Hides Imaging Set. Can be used to prevent users from viewing images that need to undergo a quality control review.

Declaration

void Hide(int workspaceId, int imagingSetId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The Artifact ID of the workspace that contains the imaging set.
System.Int32	imagingSetId	The Artifact ID of a imaging set.

Examples

int workspaceId = 1015427;
int imagingSetId = 2;
_imagingSetService.Hide(workspaceId, imagingSetId);

Release(Int32, Int32)

Releases hidden images. Used to make images available to reviewers after a quality control review has been completed on hidden images.

Declaration

void Release(int workspaceId, int imagingSetId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The Artifact ID of the workspace that contains the imaging set.
System.Int32	imagingSetId	The Artifact ID of a imaging set.

Examples

int workspaceId = 1015427;
int hiddenImagingSetId = 2;
_imagingSetService.Release(workspaceId, imagingSetId);

Update(Int32, Int32, ImagingSetRequest)

Updates Imaging Set by given imagingSetRequest.

Declaration

int Update(int workspaceId, int imagingSetId, ImagingSetRequest imagingSetRequest)

Parameters

Type	Name	Description
System.Int32	workspaceId	The Artifact ID of the workspace that contains the imaging set.
System.Int32	imagingSetId	The Artifact ID of a imaging set.
ImagingSetRequest	imagingSetRequest	The Imaging Set Request that included basing information about the Imaging Set that should be updated.

Returns

Type	Description
System.Int32	The Artifact ID of updated Imaging Set.

Examples

int workspaceId = 1015427;
int existingImagingSetId = 1213;
int imagingSetId = 2;
int existingDatSourceId = 3;
int existingImagingProfileID = 4;
var imagingSetUpdateRequest = new ImagingSetRequest
{
	DataSourceID = existingDatSourceId,
	ImagingProfileID = existingImagingProfileID,
	Name = "Updated Name"
};
int updatedImagingSetId = _imagingSetService.Update(workspaceId, existingImagingSetId, imagingSetUpdateRequest);

int workspaceId = 1015427;
int existingImagingSetId = 1213;
ImagingSet existingImagingSet = _imagingSetService.Get(workspaceId, existingImagingSetId);
var imagingSetUpdateRequest = new ImagingSetRequest
{
	DataSourceID = existingImagingSet.DataSourceId,
	ImagingProfileID = existingImagingSet.ImagingProfile.ArtifactID,
	Name = "Updated Name"
};
int updatedImagingSetId = _imagingSetService.Update(workspaceId, existingImagingSetId, imagingSetUpdateRequest);