Class OwnWorkflow

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

A workflow\instance for the initiator of the request.

public class OwnWorkflow : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

OwnWorkflow

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CreateDate

Creation date of the request.

public DateTime CreateDate { get; set; }

Property Value

Type	Description
DateTime

DocId

Document id which is used for start of the request.

public int DocId { get; set; }

Property Value

Type	Description
int

DocumentName

Name of the document.

public string DocumentName { get; set; }

Property Value

Type	Description
string

ExecutionState

Indicates whether the workflow is completed or pending.

public RequestExecutionStateEnum ExecutionState { get; set; }

Property Value

Type	Description
RequestExecutionStateEnum

FcGuid

File cabinet id of the document.

public string FcGuid { get; set; }

Property Value

Type	Description
string

HistoryRelationLink

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

public string HistoryRelationLink { get; }

Property Value

Type	Description
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) .

public string Id { get; set; }

Property Value

Type	Description
string

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

SelfRelationLink

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

public string SelfRelationLink { get; }

Property Value

Type	Description
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.

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

Property Value

Type	Description
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.

public string TakenDecisionName { get; set; }

Property Value

Type	Description
string

WorkflowName

Name of the request.

public string WorkflowName { get; set; }

Property Value

Type	Description
string

Methods

DeleteSelfRelation()

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

public string DeleteSelfRelation()

Returns

Type	Description
string	The content of the response.

DeleteSelfRelationAsync()

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

public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<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.

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

Parameters

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

Returns

Type	Description
Task<DeserializedHttpResponse<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”.

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.

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromHistoryRelationAsync()

Returns

Type	Description
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.

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

Parameters

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

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<OwnWorkflow>> GetOwnWorkflowFromSelfRelationAsync()

Returns

Type	Description
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.

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

Parameters

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

Returns

Type	Description
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.

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The 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.