Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [MsgRouter] >  [VDocRuleAssist]
Private  Storage   

abstract class EnsLib.MsgRouter.VDocRuleAssist extends Ens.Rule.Assist

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
15


Summary

Methods
GenerateActionDefinitionSchemas GenerateActionSchema GenerateArraySchema
GenerateAssignSchema GenerateCommentSchema GenerateConditionSchema
GenerateDebugSchema GenerateDefaultPropertiesSchema GenerateDelegateSchema
GenerateDeleteSchema GenerateElseSchema GenerateExpressionObjectSchema
GenerateReturnSchema GenerateRuleSchema GenerateRuleSetSchema
GenerateSchema GenerateSchemaDefinitions GenerateSendSchema
GenerateTraceSchema GetContextClass GetDescription
GetIsRoutingRule GetIsSegmentedDoc GetMetaData
GetPropertyList GetQueryData GetShortDisplay
GetValidActions GetValidConditionActions GetValidElseActions
GetValidRuleSetActions IsHidden RuntimeConstraintCheck
getClassPropertyList getClassPropertyType

Subclasses
EnsLib.EDI.MsgRouter.SegmentedRuleAssist

Methods

• classmethod GenerateDelegateSchema()
• classmethod GenerateDeleteSchema()
• classmethod GenerateReturnSchema()
Generates the schema for a return objects
• classmethod GenerateRuleSchema() as %DynamicObject
Add constraint to user-visible properties of routing rule Rules
• classmethod GenerateSchema() as %DynamicObject
Add production to user-visible properties of routing rule Rule Definitions
• classmethod GenerateSendSchema()
• classmethod GetContextClass() as %String
Returns the context class. If the return value is not null, then users can not change it
• classmethod GetDescription() as %String
Returns the description of the rule type
• classmethod GetIsRoutingRule() as %String
Returns if the rule is a routing rule
• classmethod GetMetaData() as %String
This method returns the meta data for the cconstraint fields The structure of the meta data is the following: meta-data = comma separted list of fields field = colon separated values: = constraint-field-name : caption : [collection] # [type] [ # parameter ] the valid value for collection-type is commalist or null the valid values for type is configname, class or query the parameter for class is passed to the class finder dialog box.
• classmethod GetPropertyList(ByRef pArray, pText) as %String
This method is called to return a list of properties
• classmethod GetQueryData(ByRef pArray, pParam) as %String
This method is called when the constraint type is query. This method returns a comma separated list of all the possible values for a particular field The list will be used to populated the combo box.
• classmethod GetValidActions()
Defines the valid actions for this rule type
• classmethod RuntimeConstraintCheck(ByRef pArray, pContext, Output pPassed) as %Status
This method is called at runtime for constraint check The method is to return 1 or 0 on the output parameter pPassed


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