This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Caché & Ensemble 2018.1.5 > Class Reference > ENSLIB namespace > Ens.Rule.Router.Action

Ens.Rule.Router.Action

persistent class Ens.Rule.Router.Action extends %Library.Persistent, %XML.Adaptor

SQL Table Name: Ens_Rule_Router.RuleAction

Represents an Action associated with a Rule within a MsgRouter rule.

Property Inventory

Method Inventory

Parameters

parameter XMLIGNORENULL = 1;
Ensure that we don't get $C(0) for values that are empty strings

Properties

property ActionNo as %Integer (XMLPROJECTION = "none") [ InitialExpression = $I(^Ens.Rule.ActionC("ActionNo")) , Required ];
Property methods: ActionNoDisplayToLogical(), ActionNoGet(), ActionNoGetStored(), ActionNoIsValid(), ActionNoLogicalToDisplay(), ActionNoNormalize(), ActionNoSet(), ActionNoXSDToLogical()
relationship Rule as Ens.Rule.Router.Rule [ Required , Inverse = Actions , Cardinality = parent ];
Parent Rule.
Property methods: RuleCheck(), RuleDelete(), RuleGet(), RuleGetObject(), RuleGetObjectId(), RuleGetStored(), RuleGetSwizzled(), RuleIsValid(), RuleNewObject(), RuleOnDelete(), RuleRClose(), RuleRExec(), RuleRFetch(), RuleRelate(), RuleSQLCompute(), RuleSet(), RuleSetObject(), RuleSetObjectId(), RuleUnRelate(), RuleUnSwizzle()
property Target as %String);
Name of target (host name) to send the message to if this action is fired Type is "send".
Property methods: TargetDisplayToLogical(), TargetGet(), TargetGetStored(), TargetIsValid(), TargetLogicalToDisplay(), TargetLogicalToOdbc(), TargetNormalize(), TargetSet()
property Transform as %String);
If defined, name of data transformation used for this message if this action is fired Type is "send".
Property methods: TransformDisplayToLogical(), TransformGet(), TransformGetStored(), TransformIsValid(), TransformLogicalToDisplay(), TransformLogicalToOdbc(), TransformNormalize(), TransformSet()
property Type as %String (MAXLEN = 50, VALUELIST = ",send,delete,stop,contin,delegate", XMLNAME = "type", XMLPROJECTION = "attribute") [ InitialExpression = "AND" , Required ];
What type of action this is. The possible values are:
send Send the message to a target and, if defined, apply a transformation (before sending).
delete Delete the message.
delegate Forward the message to a different rule for processing.
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()

Methods

classmethod GetTypeList() as %String
Called by U.I. to get list of action types.

Indexes

index (ID on ActionNo) [IdKey, Type = key];
Make sure actions are ordered correctly
Index methods: IDCheck(), IDDelete(), IDExists(), IDOpen(), IDSQLCheckUnique(), IDSQLExists(), IDSQLFindPKeyByConstraint(), IDSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (Ens.Rule.Router.Action)

{%%PARENT}("Actions")(ID)
=
%%CLASSNAME
Target
Transform
Type
Feedback