Table of Contents

Class ResponseAction

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

An action executed by a Response

public abstract class ResponseAction : ADTObject
Inheritance
object
ResponseAction
Derived

Properties

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

DescriptionOverride

Override for the system-generated description of the object

public string DescriptionOverride { get; set; }

Property Value

string

Remarks

This property is for use by user interface extensions

Enabled

Determines whether the action is enabled

public bool Enabled { get; set; }

Property Value

bool

Remarks

Disabled actions are not executed when the Response is triggered

Name

Optional name for the action.

public string Name { get; set; }

Property Value

string

Remarks

If no Name is specified, a system-generated description based on the settings is returned by GetObjectDescription().

Sequence

The sequence number for the action

public int Sequence { get; }

Property Value

int

Remarks

The Sequence is set automatically when the action is added to the Response's Actions collection. To reorder the action you must remove it from the collection and then insert it at the desired location.

UserInterfaceExtensionData

Extension data for the customer user interface for this object

public string UserInterfaceExtensionData { get; set; }

Property Value

string

UserInterfaceExtensionID

Extension ID of the customer user interface for this object

public string UserInterfaceExtensionID { get; set; }

Property Value

string

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

GetActionDescription() 

protected abstract string GetActionDescription()

Returns

string

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members