org.dmd.dmc.rules

Interface RuleIF

All Known Subinterfaces:

AttributeValidationIF, AttributeValidationWithResolverIF, InitializationIF, ObjectValidationIF, UCOAttributeAuditIF, UCOAttributeNormalizationIF, UCOMappingIF, UCOObjectAuditIF, UCOObjectNormalizationIF, UCOValidationIF

All Known Implementing Classes:

AllowedAttributesRule, AllowedAttributesRuleBaseImpl, CardinalityRule, CardinalityRuleBaseImpl, CheckAttributesBasedOnValueRule, CheckAttributesBasedOnValueRuleBaseImpl, InitRule, InitRuleBaseImpl, NamedObjectRule, NamedObjectRuleBaseImpl, NumericRangeRule, NumericRangeRuleBaseImpl, OneOfTheseAttributesRequiredRule, OneOfTheseAttributesRequiredRuleBaseImpl, OnlyOneOfTheseAttributesAllowedRule, OnlyOneOfTheseAttributesAllowedRuleBaseImpl, PartCheckerRule, PartCheckerRuleBaseImpl, PatternMatchRule, PatternMatchRuleBaseImpl, ReferencedAttributeTypeRule, ReferencedAttributeTypeRuleBaseImpl, RelatedNumbersRule, RelatedNumbersRuleBaseImpl, RestrictReferencesRule, RestrictReferencesRuleBaseImpl, StringSetRule, StringSetRuleBaseImpl, UCOAllowedAttributesRule, UCOAllowedAttributesRuleBaseImpl, ValueLengthRule, ValueLengthRuleBaseImpl

public interface RuleIF

A convenience interface to allow access to information that is common to all rules.

Method Summary

Modifier and Type	Method and Description
DmcAttributeInfo	getApplyToAttribute()
DmcClassInfo	getApplyToClass()
Iterator<Integer>	getCategories()
RuleKey	getKey()
String	getMsgKey()
Iterator<String>	getMsgParam()
DmcClassInfo	getRuleClass()
RuleDataDMO	getRuleDataDMO()
String	getRuleTitle()
RuleTypeEnum	getRuleType()

Method Detail

getRuleTitle

String getRuleTitle()

Returns:

the title of the rule.

getRuleType

RuleTypeEnum getRuleType()

Returns:

the rule type.

getRuleClass

DmcClassInfo getRuleClass()

Returns:

the class info of the rule data.

getRuleDataDMO

RuleDataDMO getRuleDataDMO()

Returns:

the data associated with the rule.

getCategories

Iterator<Integer> getCategories()

Returns:

the identifiers of the categories to which this rule belongs.

getApplyToClass

DmcClassInfo getApplyToClass()

Returns:

the info for the class to which this rule should be applied or null if it's a global rule. For CLASS rules, a global rule is applied to all classes. For an ATTRIBUTE rule, a global rule is applied to the attribute regardless of the class in which it exists.

getApplyToAttribute

DmcAttributeInfo getApplyToAttribute()

Returns:

the info for the attribute to which this rule should be applied or null if it's a global attribute rule.

getKey

RuleKey getKey()

Returns:

the key that uniquely identifies this rule

getMsgParam

Iterator<String> getMsgParam()

Returns:

the parameters to be substituted into a translated message

getMsgKey

String getMsgKey()

Returns:

the key of a translated message