abstract class EnsLib.MsgRouter.VDocRuleAssistCompatible
extends Ens.Rule.Assist
|
Parameters
|
Properties
|
Methods
|
Queries
|
Indices
|
ForeignKeys
|
Triggers
|
|
|
|
15
|
|
|
|
|
• classmethod GenerateDelegateSchema()
• classmethod GenerateDeleteSchema()
• classmethod GenerateReturnSchema()
Generates the schema for a return objects
• classmethod GenerateRuleSchema()
as %DynamicObject
Generates the schema for a rule objects
• classmethod GenerateSchema()
as %DynamicObject
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
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 IsHidden()
as %String
If return true, then the class is excluded from the new rule wizard
• 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
