Class OwnWorkflow

A workflow\instance for the initiator of the request.

Inheritance

System.Object

OwnWorkflow

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class OwnWorkflow : IRelationsWithProxy

Properties

CreateDate

Creation date of the request.

Declaration

public DateTime CreateDate { get; set; }

Property Value

Type	Description
System.DateTime

DocId

Document id which is used for start of the request.

Declaration

public int DocId { get; set; }

Property Value

Type	Description
System.Int32

DocumentName

Name of the document.

Declaration

public string DocumentName { get; set; }

Property Value

Type	Description
System.String

ExecutionState

Indicates whether the workflow is completed or pending.

Declaration

public RequestExecutionStateEnum ExecutionState { get; set; }

Property Value

Type	Description
RequestExecutionStateEnum

FcGuid

File cabinet id of the document.

Declaration

public string FcGuid { get; set; }

Property Value

Type	Description
System.String

HistoryRelationLink

Gets the Uri of the link for the relation “history”.

Declaration

public string HistoryRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “history” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Id

Identifier of the request (instance id) .

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

SelfRelationLink

Gets the Uri of the link for the relation “self”.

Declaration

public string SelfRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “self” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

TakenDecision

List of confirmed requests.

Declaration

public List<RequestDataDecision> TakenDecision { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<RequestDataDecision>

TakenDecisionName

If all assigned users confirm one and the same decision it contains the name of the decision. Otherwise it contains WF_DIFFERENTDECISIONS.

Declaration

public string TakenDecisionName { get; set; }

Property Value

Type	Description
System.String

WorkflowName

Name of the request.

Declaration

public string WorkflowName { get; set; }

Property Value

Type	Description
System.String

Methods

DeleteSelfRelation()

Calls the HTTP Delete method on the link for the relation “self”.

Declaration

public string DeleteSelfRelation()

Returns

Type	Description
System.String	The content of the response.

DeleteSelfRelationAsync()

Calls the HTTP Delete method on the link for the relation “self” asynchronously.

Declaration

public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “self”.

DeleteSelfRelationAsync(CancellationToken)

Calls the HTTP Delete method on the link for the relation “self” asynchronously.

Declaration

public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “self”.

GetInstanceHistoryFromHistoryRelation()

Calls the HTTP Get method on the link for the relation “history”.

Declaration

public InstanceHistory GetInstanceHistoryFromHistoryRelation()

Returns

Type	Description
InstanceHistory	The content of the response.

GetInstanceHistoryFromHistoryRelationAsync()

Calls the HTTP Get method on the link for the relation “history” asynchronously.

Declaration

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromHistoryRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<InstanceHistory>>	A task which runs the request.

Remarks

This method follows the link for the relation “history”.

GetInstanceHistoryFromHistoryRelationAsync(CancellationToken)

Calls the HTTP Get method on the link for the relation “history” asynchronously.

Declaration

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromHistoryRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<InstanceHistory>>	A task which runs the request.

Remarks

This method follows the link for the relation “history”.

GetOwnWorkflowFromSelfRelation()

Calls the HTTP Get method on the link for the relation “self”.

Declaration

public OwnWorkflow GetOwnWorkflowFromSelfRelation()

Returns

Type	Description
OwnWorkflow	The content of the response.

GetOwnWorkflowFromSelfRelationAsync()

Calls the HTTP Get method on the link for the relation “self” asynchronously.

Declaration

public Task<DeserializedHttpResponse<OwnWorkflow>> GetOwnWorkflowFromSelfRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<OwnWorkflow>>	A task which runs the request.

Remarks

This method follows the link for the relation “self”.

GetOwnWorkflowFromSelfRelationAsync(CancellationToken)

Calls the HTTP Get method on the link for the relation “self” asynchronously.

Declaration

public Task<DeserializedHttpResponse<OwnWorkflow>> GetOwnWorkflowFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<OwnWorkflow>>	A task which runs the request.

Remarks

This method follows the link for the relation “self”.

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

Declaration

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The System.Net.Http.HttpClient instance which is used in further HTTP communication.

Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.