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

class Ens.BPL.Rule extends Ens.BPL.Activity

This class represents an invocation of a a Rule.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 4


Summary

Properties
ActivityID Annotation Disabled LanguageOverride
Name Parent ReasonLocation ResultLocation
Rule RuleContext 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


Properties

• property ReasonLocation as %String;
This holds the name of the context property that will contain the reason value (i.e., which rule actually fired) returned by the Rule Engine.
• property ResultLocation as %String;
This holds the name of the context property that will contain the return value of the rule.
• property Rule as %String;
This holds the name of the associated Business Rule that will be invoked.
• property RuleContext as %String;
If provided, this is an expression (e.g., "context.myProperty") that provides the context object passed to the Rules Engine.
If not provided, the Business Process context object is passed to the Rules Engine.

Methods

• 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


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