Class WorkflowError

Namespace

Acuit.Pinpoint.Client2

Assembly

Acuit.Pinpoint.Client2.dll

A unit workflow error.

[DataContract]
public class WorkflowError : IExtensibleDataObject

Inheritance

object

WorkflowError

Implements

IExtensibleDataObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

WorkflowError(string)

Initializes a new instance of the WorkflowError class.

public WorkflowError(string message)

Parameters

message string

The error message text.

WorkflowError(string, bool)

Initializes a new instance of the WorkflowError class.

public WorkflowError(string message, bool isSilent)

Parameters

message string

The error message text.

isSilent bool

Whether this error came from a silent check.

Properties

ExtensionData

Gets or sets the structure that contains extra data.

public virtual ExtensionDataObject ExtensionData { get; set; }

Property Value

ExtensionDataObject

IsSilent

Gets or sets whether to suppress the display of this workflow error to the operator.

[DataMember(Order = 100)]
public bool IsSilent { get; set; }

Property Value

bool

Remarks

Workflow errors are normally displayed at the station via a popup message at manned stations or alarms at automated stations. If this property is true, this error will not be displayed, but it will still affect business logic (e.g., transitions will not occur).

Message

Gets the error message text.

[DataMember]
public string Message { get; }

Property Value

string

Methods

ToString()

Returns the Message value as a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.