IDbStateEnum

An interface that identifies this Entity as being the enumeration details for the SimpleStateMachine.

Syntax

public interface IDbStateEnum : IDbEnum, IIdentifiable<Guid>, IActiveTrackable, IHumanReadable, ISortable

Properties

InstructionText

string InstructionText { get; set; }
Text to display to the user regarding the current state, and what needs to happen next.

Returns

string

PrimaryTargetDisplayText

string PrimaryTargetDisplayText { get; set; }
A string that describes the next action in the SimpleStateMachine, usually displayed on a button or link.

Returns

string

PrimaryTargetSortOrder

int PrimaryTargetSortOrder { get; set; }
An integer that represents the State the Entity should be moved to once this action completes successfully.

Returns

int

SecondaryTargetDisplayText

string SecondaryTargetDisplayText { get; set; }
A string that describes an alternate action in the SimpleStateMachine. This action could skip States moving forward, or return the Entity to a previous State. This text is usually displayed on a button or link.

Returns

string

SecondaryTargetSortOrder

int SecondaryTargetSortOrder { get; set; }
An integer that represents an alternate State the Entity should be moved to once this action is finished.

Returns

int