Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [Rule] >  [RuleSet]
Private  Storage   

persistent class Ens.Rule.RuleSet extends RuleDefinition

Defines an Ensemble Business Rule set. This is a specific type of Rule definition.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 2 2


%ErrorMsg %Reason %ReturnValue %StackLevel
CompileStatus ContextClass DefaultValue Description
EffectiveBeginDateTime EffectiveEndDateTime FullName HasErrors
HostClass Name Production ReportGroup
ReportName RoutineName Rules ShortDescription
TimeModified Version

%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %Notify
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDelete %OnDetermineClass %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SaveIndices %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject Compile ContextClassGet ConvertStorageGlobal
EffectiveBeginDateTimeSet EffectiveEndDateTimeSet Evaluate EvaluateRules
EvaluateRulesEx Exists GenerateCode GetLatestVersion
Load LoadFile NameSet Open
OpenEffective PurgeOldVersions PurgeRuleCache RecompileAll
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType


• parameter COMPILABLE = 1;
Indicates if this Rule Engine supports compilation.
• parameter RULEEDITORURL = "UtilEnsRuleEditor.csp";
URL (csp page) for Rule Editor associated with the Rule Definition class.
• parameter XMLNAME = "ruleSet";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


• property DefaultValue as %String(MAXLEN=128,XMLNAME="default",XMLPROJECTION="ATTRIBUTE");
Default value returned by this Rule Set.
• relationship Rules as Rule(XMLNAME="rule",XMLPROJECTION="ELEMENT") [ Inverse = RuleSet,Cardinality = children ];
Set of Rules that define this Rule Set.


• method Evaluate(pContext As %RegisteredObject) as %Status
Evaluate this Rule Set. The resulting return value is returned via the %ReturnValue property.
• method GenerateCode(pCompiler As Compiler) as %Status
Generate executable code for this Rule

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