Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [Ens] >  [BPL] >  [Activity]
Private  Storage   

abstract class Ens.BPL.Activity extends Ens.BPL.Node

Base class for all Activity nodes. An Activity is an action of some kind which is executed by the BPL runtime

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 9 5


Summary

Properties
ActivityID Annotation Disabled LanguageOverride
Name Parent XEnd XPos
YEnd YPos

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

Subclasses
Ens.BPL.Alert Ens.BPL.Assign Ens.BPL.Branch
Ens.BPL.Break Ens.BPL.Call Ens.BPL.Catch
Ens.BPL.CatchAll Ens.BPL.Code Ens.BPL.Compensate
Ens.BPL.CompensationHandler Ens.BPL.Continue Ens.BPL.Delay
Ens.BPL.Empty Ens.BPL.Flow Ens.BPL.ForEach
Ens.BPL.If Ens.BPL.Label Ens.BPL.Milestone
Ens.BPL.Receive Ens.BPL.Reply Ens.BPL.Rule
Ens.BPL.SQL Ens.BPL.Scope Ens.BPL.Sequence
Ens.BPL.Switch Ens.BPL.Sync Ens.BPL.Throw
Ens.BPL.Trace Ens.BPL.Transform Ens.BPL.Until
Ens.BPL.While Ens.BPL.XPATH Ens.BPL.XSLT

Parameters

• parameter SubActivities;
This holds the subactivity list

Properties

• property ActivityID as %Integer;
This holds the unique id for this activity
• property Annotation as %String(MAXLEN="");
This holds the user documentation for this Activity
• property Disabled as %Boolean;
This holds the 'disabled' status for the activity.
• property LanguageOverride as %String(VALUELIST=",python,objectscript,basic");
Optional setting. Sets the compilation language at level of activity. To be useful, this will differ from the main BPL language.
Example 1: When the overall BPL is generating in ObjectScript mode, this setting can allow a specific BPL Code block activity to accomodate Embedded Python source code.
Example 2: When the overall BPL is generating in ObjectScript mode, this setting can allow a specific BPL Assignment activity expression to accomodate Embedded Python code expression.
• property Name as %String(MAXLEN=255);
This holds the name of the activity..For most activities this name is optional but for some it is required e.g. Ens.BPL.Process
• property XEnd as %Integer;
This holds the X position for the associated closing shape of the gui representation of this node
• property XPos as %Integer;
This holds the X position of the gui representation of this node
• property YEnd as %Integer;
This holds the Y position for the associated closing shape of the gui representation of this node
• property YPos as %Integer;
This holds the Y position of the gui representation of this node

Methods

• method DisabledGet() as %Boolean
Determine whether this Activity is disabled
• method DisplayName() as %String
Provide a user readable string which identifies this node
• method GenerateAnnotation(pStream As %BinaryStream)
• method GenerateXML(pStream As %BinaryStream) as %Status
This generates the common XML attributes for this Activity


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.