Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / Ens.BPL.ForEach
Private  Storage   

Ens.BPL.ForEach


class Ens.BPL.ForEach extends
Ens.BPL.Activity

Defines a sequence of activities to be executed iteratively.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 5


Summary


Properties
Activities ActivityID Annotation Disabled Key
Name Parent Property XEnd XPos
YEnd YPos

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject DisabledGet DisplayName GenerateAnnotation
GenerateCode GenerateXML NormalizeAttribute Validate


Properties


• property Activities as Ens.BPL.ActivityList;
This holds the Activity list which represents the loop body
• property Key as %String;
This holds the key to use for iteration of the property
• property Property as %String;
This holds the name of the property

Methods


• private method %OnNew(initvalue As %RawString) as %Status
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 GenerateCode(pCompiler As Ens.BPL.Compiler) as %Status
• method GenerateXML(pStream As %BinaryStream) as %Status
This generates the common XML attributes for this Activity
• method Validate(ByRef pStatus As %Status, pContext As Ens.BPL.ValidationContext) as %Status
Perform a sanity check on the nodes in the parse tree
• private method activityName() as %String
Provide a user readable string which names the activity