Interface IApplicationFieldCodeService

Represents the Application Field Code API service.

Namespace: Relativity.Testing.Framework.Api.Services

Assembly: Relativity.Testing.Framework.Api.dll

Syntax

public interface IApplicationFieldCodeService

Examples

_applicationFieldCodeService = relativityFacade.Resolve<IApplicationFieldCodeService>();

Methods

Create(Int32, ApplicationFieldCode)

Creates a new Application Field Code instance.

Declaration

ApplicationFieldCode Create(int workspaceId, ApplicationFieldCode applicationFieldCode)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
ApplicationFieldCode	applicationFieldCode	A ApplicationFieldCode object to be created.

Returns

Type	Description
ApplicationFieldCode	Returns an ApplicationFieldCode instance.

Examples

var workspaceId = 1015427;
var applicationFieldCode = new ApplicationFieldCode()
{
	Application = ApplicationType.MicrosoftExcel,
	FieldCode = "Author",
	Option = ApplicationFieldCodeOption.DocumentDefault
};
var createdApplicationFieldCode = _applicationFieldCodeService.Create(workspaceId, applicationFieldCode);

Delete(Int32, Int32)

Deletes an Application Field Code instance.

Declaration

void Delete(int workspaceId, int applicationFieldCodeId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	applicationFieldCodeId	The Artifact ID of the ApplicationFieldCode instance to delete.

Examples

var workspaceId = 1015427;
var applicationFieldCodeId = 1018877;
_applicationFieldCodeService.Delete(workspaceId, applicationFieldCodeId);

Get(Int32, Int32)

Retrieves the ApplicationFieldCode with the specified Artifact ID.

Declaration

ApplicationFieldCode Get(int workspaceId, int applicationFieldCodeId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	applicationFieldCodeId	The Artifact ID of the ApplicationFieldCode instance to read.

Returns

Type	Description
ApplicationFieldCode	Returns an ApplicationFieldCode instance.

Examples

var workspaceId = 1015427;
var applicationFieldCodeId = 1018877;
var applicationFieldCode = _applicationFieldCodeService.Get(workspaceId, applicationFieldCodeId);

Update(Int32, ApplicationFieldCode)

Updates an existing Application Field Code instance.

Declaration

ApplicationFieldCode Update(int workspaceId, ApplicationFieldCode applicationFieldCode)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
ApplicationFieldCode	applicationFieldCode	An ApplicationFieldCode object with updated fields, reflecting the desired final state of the Application Field Code.

Returns

Type	Description
ApplicationFieldCode	Returns an ApplicationFieldCode instance.

Examples

var workspaceId = 1015427;
var applicationFieldCodeId = 1018877;
var applicationFieldCode = _applicationFieldCodeService.Get(workspaceId, applicationFieldCodeId);
applicationFieldCode.Option = ApplicationFieldCodeOption.DocumentDefault;
var updatedApplicationFieldCode = _applicationFieldCodeService.Update(workspaceId, applicationFieldCode);