EnsLib.MsgRouter.VDocRuleAssistCompatible
abstract class EnsLib.MsgRouter.VDocRuleAssistCompatible extends Ens.Rule.Assist
Method Inventory
- GenerateDelegateSchema()
- GenerateDeleteSchema()
- GenerateReturnSchema()
- GenerateRuleSchema()
- GenerateSchema()
- GenerateSendSchema()
- GetContextClass()
- GetDescription()
- GetIsRoutingRule()
- GetMetaData()
- GetPropertyList()
- GetQueryData()
- GetValidActions()
- IsHidden()
- RuntimeConstraintCheck()
Methods
classmethod GenerateDelegateSchema()
classmethod GenerateDeleteSchema()
classmethod GenerateReturnSchema()
Inherited description: Generates the schema for a return objects
classmethod GenerateRuleSchema() as %DynamicObject
Inherited description: Generates the schema for a rule objects
classmethod GenerateSchema() as %DynamicObject
Inherited description: Generates the schema rule definitions of this type are expected to follow
This schema is used by the Rule Editor to hide/show certain UI elements as appropriate
The schema determines:
- what context sensitive buttons to show when elements of the rule definition are selected
- what properties are exposed for editing
The schema can also constrain:
- the number of elements of a given type which are permitted in an array
classmethod GenerateSendSchema()
classmethod GetContextClass() as %String
Inherited description: Returns the context class. If the return value is not null, then users can not change it
classmethod GetDescription() as %String
Inherited description: Returns the description of the rule type
classmethod GetIsRoutingRule() as %String
Inherited description: Returns if the rule is a routing rule
classmethod GetMetaData() as %String
Inherited description: 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
Inherited description: This method is called to return a list of properties
classmethod GetQueryData(ByRef pArray, pParam) as %String
Inherited description: 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()
Inherited description: Defines the valid actions for this rule type
classmethod IsHidden() as %String
Inherited description: If return true, then the class is excluded from the new rule wizard
classmethod RuntimeConstraintCheck(ByRef pArray, pContext, Output pPassed) as %Status
Inherited description: This method is called at runtime for constraint check
The method is to return 1 or 0 on the output parameter pPassed
Inherited Members
Inherited Methods
- GenerateActionDefinitionSchemas()
- GenerateActionSchema()
- GenerateArraySchema()
- GenerateAssignSchema()
- GenerateCommentSchema()
- GenerateConditionSchema()
- GenerateDebugSchema()
- GenerateDefaultPropertiesSchema()
- GenerateElseSchema()
- GenerateExpressionObjectSchema()
- GenerateRuleSetSchema()
- GenerateSchemaDefinitions()
- GenerateTraceSchema()
- GetIsSegmentedDoc()
- GetShortDisplay()
- GetValidConditionActions()
- GetValidElseActions()
- GetValidRuleSetActions()
- getClassPropertyList()
- getClassPropertyType()