This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

Ens.DTL.ForEach

class Ens.DTL.ForEach extends Ens.DTL.Action

Property Inventory

Method Inventory

Parameters

parameter TAGNAME = foreach;

Properties

property Actions as Ens.DTL.ActionList;
This holds the Activity list which represents the loop body
Property methods: ActionsGet(), ActionsGetSwizzled(), ActionsIsValid(), ActionsNewObject(), ActionsSet()
property Key as %String;
This holds the key to use for iteration of the property
Property methods: KeyDisplayToLogical(), KeyGet(), KeyIsValid(), KeyLogicalToDisplay(), KeyLogicalToOdbc(), KeyNormalize(), KeySet()
property Property as %String;
This holds the name of the property
Property methods: PropertyDisplayToLogical(), PropertyGet(), PropertyIsValid(), PropertyLogicalToDisplay(), PropertyLogicalToOdbc(), PropertyNormalize(), PropertySet()

Methods

method %OnNew(initvalue) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method Deserialize(pState As %String) as %Status
Fill in properties of this item from the serial string
method DisplayName() as %String
Provide a user readable string which names the activity
method GenerateCode(pCompiler As Ens.DTL.Compiler) as %Status
method GenerateXML(pStream As %BinaryStream) as %Status
method Serialize(pStream As %CharacterStream) as %Status
Serialize this transform for use by DTL editor
method Validate(ByRef pStatus As %Status, pContext As Ens.DTL.ValidationContext) as %Status
Perform a sanity check on the nodes in the parse tree

Inherited Members

Inherited Properties

Inherited Methods

Feedback