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

class Ens.Projection.Rule extends %Projection.AbstractProjection

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5


Summary

Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
AddToManifest CreateProjection EndCompile GetRuleNameList
QueueClass RemoveFromManifest RemoveFromQueue RemoveProjection
ResolveRuleAlias SetQueueFlag ValidateAlias getDefaultParam
getROOTDIR


Methods

• classmethod CreateProjection(classname As %String, ByRef parameters As %String) as %Status
This method is called by the Class Compiler whenever an associated class has finished compiling. classname contains the name of the associated class while parameters contains an array of the projection parameters subscripted by parameter name. Also the special parameter value parameters("%qstruct") contains a merge of the qstruct array this projection is being compiled with. The modified is always blank.
Any errors reported by this method are reported by the Class Compiler but do not effect class compilation in any way.
• classmethod GetRuleNameList(Output list As %String) as %String
Retrieve all known rule classes and aliases in subscripts of list. In the case of aliases, the class name is returned as the value at the alias's subscript.
• classmethod RemoveProjection(classname As %String, ByRef parameters As %String, recompile As %Boolean, modified As %String) as %Status
This method is called by the Class Compiler whenever an associated class is either a) about to be recompiled, or b) about to be deleted. classname contains the name of the associated class while parameters contains an array of the projection parameters subscripted by parameter name. Also the special parameter value parameters("%qstruct") contains a merge of the qstruct array this projection is being compiled with. recompile is true (1) if the associated class is about to be recompiled. The modified is always blank.
Any errors reported by this method are reported by the Class Compiler but do not effect class compilation in any way.
• classmethod ResolveRuleAlias(alias As %String = "") as %String
Return the class name for the rule class or alias supplied in alias.
• classmethod ValidateAlias(classname As %String = "", alias As %String = "") as %Status
General-purpose method to ensure that there are no alias collisions.


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