Class ActionResult

class representing the result of an action.

Inheritance

System.Object

ActionResult

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TimeCockpit.Data

Assembly: TimeCockpit.Data.dll

Syntax

public class ActionResult

Constructors

ActionResult(String, IEnumerable<EntityObject>, Exception, IActionResult)

Initializes a new instance of the ActionResult class.

Declaration

public ActionResult(string output, IEnumerable<EntityObject> modifiedInputSet, Exception exception = null, IActionResult result = null)

Parameters

Type	Name	Description
System.String	output	the output of the action.
System.Collections.Generic.IEnumerable<EntityObject>	modifiedInputSet	the modified input set.
System.Exception	exception	optionally, an exception is one was thrown.
IActionResult	result	optionally, a result of the action.

Properties

Exception

Gets a possible exception, may be null.

Declaration

public Exception Exception { get; }

Property Value

Type	Description
System.Exception

ModifiedInputSet

Gets the entityobjects in the state after they have been modified by the action.

Declaration

public IEnumerable<EntityObject> ModifiedInputSet { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<EntityObject>

Output

Gets the output of the action.

Declaration

public string Output { get; }

Property Value

Type	Description
System.String

Result

Gets a possible result from the action.

Declaration

public IActionResult Result { get; }

Property Value

Type	Description
IActionResult

Methods

Succeeded()

Determines if the action has been executed successfully.

Declaration

public bool Succeeded()

Returns

Type	Description
System.Boolean	Returns a value indicating if the action has been executed successfully.