Class TriggerActionParameter

The server task parameters for the trigger action process

Inherits from the item server task parameter which records the id and label of the IActionTrigger this task should be calculated against

Evaluate any triggers setup against the specified data and run associated action.
Inheritance
object
SerializedParam
ServerTaskParameter
ItemParameter
TriggerActionParameter
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Run Trigger", "12737356-A000-436B-8640-C18406499341", Description = "Evaluate any triggers setup against the specified data and run associated action.")]
public class TriggerActionParameter : ItemParameter, ICloneable, INotifyPropertyChanged

Constructors

TriggerActionParameter()

Declaration
public TriggerActionParameter()

Fields

UNIQUE_TASK_ID

The unique id of the trigger action calculation server task

Declaration
public const string UNIQUE_TASK_ID = "12737356-A000-436B-8640-C18406499341"
Field Value
Type Description
string

Properties

Action

A custom string for matching on custom actions ActionOnActionMatch

Declaration
public string Action { get; set; }
Property Value
Type Description
string

EntityTypeID

A unique list of entity types that have been modified and should be checked to see if their modification triggers a configured action

Declaration
public Guid[] EntityTypeID { get; set; }
Property Value
Type Description
Guid[]

FirstEntityTypeID

The entity type id of the first entity type that was modified in the EntityTypeID

Declaration
public Guid FirstEntityTypeID { get; set; }
Property Value
Type Description
Guid

SaveSetSTamp

The unique date time stamp the modification occured so the system can check all modified items at that time stamp

Declaration
public DateTimeOffset? SaveSetSTamp { get; set; }
Property Value
Type Description
DateTimeOffset?

Methods

AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask, IEntityUpdater)

Returns false - the system should not automatically allow saving without changes

Declaration
public override bool AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask item, IEntityUpdater context)
Parameters
Type Name Description
IHasSaveProcessingTask item

The trigger action that has been modified
IEntityUpdater context

The current context that it has been modified within
Returns
Type Description
bool

False
Overrides

Clone()

Declaration
public TriggerActionParameter Clone()
Returns
Type Description
TriggerActionParameter

CopyFromParam(SerializedParam)

Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified source

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source

The source instance of a SerializedParam that is of the same type as this one to copy parameter values from
Overrides
Remarks

Used by the generic implementation of Clone()

CopyFromSource(TriggerActionParameter)

Declaration
public void CopyFromSource(TriggerActionParameter source)
Parameters
Type Name Description
TriggerActionParameter source

CreateNewParam()

Must be implemented by inheriting classes to provide a new instance of the current class type.

Used when cloning this SerializedParam to create a new instance of the same type

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam

A new instance of the current SerializedParam type
Overrides

DisplayUserParamOnSave(IHasSaveProcessingTask, IEntityUpdater)

Returns false - the system should not automatically display the task parameters during save

Declaration
public override bool DisplayUserParamOnSave(IHasSaveProcessingTask item, IEntityUpdater context)
Parameters
Type Name Description
IHasSaveProcessingTask item

The trigger action that has been modified
IEntityUpdater context

The current context that it has been modified within
Returns
Type Description
bool

False
Overrides

GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Returns that this is a trigger recalculation task against the specified task description

Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type Name Description
IServerTask task

The server task for processing the trigger action
Returns
Type Description
string

A string stating that this is a trigger recalculation task against the specified task description
Overrides

ShouldAutomaticallyCreateTask(IHasSaveProcessingTask, IEntityUpdater)

Returns false - the system should not automaically create a task when modifying a trigger action

Declaration
public override bool ShouldAutomaticallyCreateTask(IHasSaveProcessingTask item, IEntityUpdater context)
Parameters
Type Name Description
IHasSaveProcessingTask item

The trigger action that has been modified
IEntityUpdater context

The current context that it has been modified within
Returns
Type Description
bool

False
Overrides

Implements

Extension Methods