org.dmd.dmv.shared.generated.rulesdmo

Class InitRuleBaseImpl

java.lang.Object

org.dmd.dmv.shared.generated.rulesdmo.InitRuleBaseImpl

All Implemented Interfaces:

DynamicInitIF, RuleIF, InitializationIF

Direct Known Subclasses:

InitRule

public abstract class InitRuleBaseImpl
extends Object
implements RuleIF, DynamicInitIF, InitializationIF

Field Summary

Fields

Modifier and Type	Field and Description
protected InitRuleDataDMO	ruleDMO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InitRuleBaseImpl()
protected	InitRuleBaseImpl(InitRuleDataDMO dmo)

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()
void	setRuleData(DmcObject obj) This method allows for the dynamic instantiation and initialization of the data associated with this rule.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dmd.dms.generated.rulesdmo.InitializationIF

execute

Field Detail

ruleDMO

protected InitRuleDataDMO ruleDMO

Constructor Detail

InitRuleBaseImpl

protected InitRuleBaseImpl()

InitRuleBaseImpl

protected InitRuleBaseImpl(InitRuleDataDMO dmo)

Method Detail

setRuleData

public void setRuleData(DmcObject obj)

This method allows for the dynamic instantiation and initialization of the data associated with this rule. It is used by the DmcSchemaParser and generally shouldn't be used unless you know what you're doing!

Specified by:

setRuleData in interface DynamicInitIF

getKey

public RuleKey getKey()

Specified by:

getKey in interface RuleIF

Returns:

the key that uniquely identifies this rule

getRuleTitle

public String getRuleTitle()

Specified by:

getRuleTitle in interface RuleIF

Returns:

the title of the rule.

getRuleClass

public DmcClassInfo getRuleClass()

Specified by:

getRuleClass in interface RuleIF

Returns:

the class info of the rule data.

getRuleType

public RuleTypeEnum getRuleType()

Specified by:

getRuleType in interface RuleIF

Returns:

the rule type.

getCategories

public Iterator<Integer> getCategories()

Specified by:

getCategories in interface RuleIF

Returns:

the identifiers of the categories to which this rule belongs.

getMsgParam

public Iterator<String> getMsgParam()

Specified by:

getMsgParam in interface RuleIF

Returns:

the parameters to be substituted into a translated message

getMsgKey

public String getMsgKey()

Specified by:

getMsgKey in interface RuleIF

Returns:

the key of a translated message

getRuleDataDMO

public RuleDataDMO getRuleDataDMO()

Specified by:

getRuleDataDMO in interface RuleIF

Returns:

the data associated with the rule.

getApplyToClass

public DmcClassInfo getApplyToClass()

Specified by:

getApplyToClass in interface RuleIF

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

public DmcAttributeInfo getApplyToAttribute()

Specified by:

getApplyToAttribute in interface RuleIF

Returns:

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

toString

public String toString()

Overrides:

toString in class Object