org.dmd.dms.generated.dmw

Class RuleDataDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.RuleDataDMW

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

RuleData

public abstract class RuleDataDMW
extends DmwNamedObjectWrapper

The RuleData class serves as a common base for all ClassDefinitions\n that are generated internally to represent the data associated with RuleDefinitions.

Author:

Auto Generated Generated from: org.dmd.dms.meta.MetaGenerator.dumpDMWClasses(MetaGenerator.java:1649)

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuleDataDMW()
protected	RuleDataDMW(DmcObject obj)
protected	RuleDataDMW(DmcObject obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addDescription(Object value) Adds another description value.
void	addMsgParam(Object value) Adds another msgParam value.
ClassDefinition	getApplyToClass() The class to which a rule should be applied.
SchemaDefinition	getDefinedIn() Indicates the schema in which a type, attribute or class is defined.
Iterator<String>	getDescription() The description attribute is used to provide descriptive\n documentation for schema related definitions.
int	getDescriptionSize()
Iterator<String>	getDescriptionWithNewlines()
RuleDataDMO	getDMO()
String	getFile() Indicates the file from which a definition was loaded.
Boolean	getImmediateHalt() The immediateHalt flag is used to indicate that no further\n rule processing should occur if a rule fails.
Integer	getLineNumber() Indicates the line number of the file from which a definition was loaded.
String	getMsgKey() The msgKey may be specified on rule instances to indicate the key to be used\n to look up translated messages.
Iterator<String>	getMsgParam() The msgParam allows for the specification of parameters to be substituted\n into translated messages.
int	getMsgParamSize()
RuleName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
RuleName	getRuleName() The ruleName attribute is used to store a single camelCase format name for a rule.\n The name starts with a single letter and can be followed by a mix of letters and numbers.
String	getRuleTitle() The title of a rule.
void	setApplyToClass(ClassDefinition value) Sets applyToClass to the specified value.
void	setDefinedIn(SchemaDefinition value) Sets definedIn to the specified value.
void	setDmcObject(DmcObject obj) Sets the core object.
void	setFile(Object value) Sets file to the specified value.
void	setImmediateHalt(Object value) Sets immediateHalt to the specified value.
void	setLineNumber(Object value) Sets lineNumber to the specified value.
void	setMsgKey(Object value) Sets msgKey to the specified value.
void	setRuleName(Object value) Sets ruleName to the specified value.
void	setRuleTitle(Object value) Sets ruleTitle to the specified value.

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

equals

Constructor Detail

RuleDataDMW

protected RuleDataDMW()

RuleDataDMW

protected RuleDataDMW(DmcObject obj)

RuleDataDMW

protected RuleDataDMW(DmcObject obj,
                      ClassDefinition cd)

Method Detail

setDmcObject

public void setDmcObject(DmcObject obj)

Description copied from class: DmcContainer

Sets the core object.

Specified by:

setDmcObject in interface DmcContainerIF

Overrides:

setDmcObject in class DmwWrapper

Parameters:

obj - The core object.

getDMO

public RuleDataDMO getDMO()

getRuleTitle

public String getRuleTitle()

The title of a rule.

Returns:

the String

setRuleTitle

public void setRuleTitle(Object value)
                  throws DmcValueException

Sets ruleTitle to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getRuleName

public RuleName getRuleName()

The ruleName attribute is used to store a single camelCase format name for a rule.\n The name starts with a single letter and can be followed by a mix of letters and numbers. No spaces or \n other characters are allowed.

Returns:

the RuleName

setRuleName

public void setRuleName(Object value)
                 throws DmcValueException

Sets ruleName to the specified value.

Parameters:

value - A value compatible with DmcTypeRuleNameSV

Throws:

DmcValueException - if the value is incorrect

getDescription

public Iterator<String> getDescription()

The description attribute is used to provide descriptive\n documentation for schema related definitions. The text provided should conform\n to XHTML concepts since it will be dumped in the context of the generated HTML\n documentation.

Returns:

the String

getDescriptionWithNewlines

public Iterator<String> getDescriptionWithNewlines()

addDescription

public void addDescription(Object value)
                    throws DmcValueException

Adds another description value.

Parameters:

value - A value compatible with DmcTypeStringMV

Throws:

DmcValueException - if the value is incorrect

getDescriptionSize

public int getDescriptionSize()

Returns:

the number of description values.

getDefinedIn

public SchemaDefinition getDefinedIn()

Indicates the schema in which a type, attribute or class is defined.

Returns:

the SchemaDefinition

setDefinedIn

public void setDefinedIn(SchemaDefinition value)
                  throws DmcValueException

Sets definedIn to the specified value.

Parameters:

value - A value compatible with SchemaDefinition

Throws:

DmcValueException - if the value is incorrect

getFile

public String getFile()

Indicates the file from which a definition was loaded.

Returns:

the String

setFile

public void setFile(Object value)
             throws DmcValueException

Sets file to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getLineNumber

public Integer getLineNumber()

Indicates the line number of the file from which a definition was loaded.

Returns:

the Integer

setLineNumber

public void setLineNumber(Object value)
                   throws DmcValueException

Sets lineNumber to the specified value.

Parameters:

value - A value compatible with DmcTypeIntegerSV

Throws:

DmcValueException - if the value is incorrect

getApplyToClass

public ClassDefinition getApplyToClass()

The class to which a rule should be applied.

Returns:

the ClassDefinition

setApplyToClass

public void setApplyToClass(ClassDefinition value)
                     throws DmcValueException

Sets applyToClass to the specified value.

Parameters:

value - A value compatible with ClassDefinition

Throws:

DmcValueException - if the value is incorrect

getImmediateHalt

public Boolean getImmediateHalt()

The immediateHalt flag is used to indicate that no further\n rule processing should occur if a rule fails. It is an optional attribute on rule instance\n objects. In somes cases, there is no point in continuing with the application of a set \n of rules, so this flag gives the option of halting further processing.

Returns:

the Boolean

setImmediateHalt

public void setImmediateHalt(Object value)
                      throws DmcValueException

Sets immediateHalt to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getMsgKey

public String getMsgKey()

The msgKey may be specified on rule instances to indicate the key to be used\n to look up translated messages. This is primarily a GWT mechanism, but should be applicable in\n other contexts.

Returns:

the String

setMsgKey

public void setMsgKey(Object value)
               throws DmcValueException

Sets msgKey to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getMsgParam

public Iterator<String> getMsgParam()

The msgParam allows for the specification of parameters to be substituted\n into translated messages.

Returns:

the String

addMsgParam

public void addMsgParam(Object value)
                 throws DmcValueException

Adds another msgParam value.

Parameters:

value - A value compatible with DmcTypeStringMV

Throws:

DmcValueException - if the value is incorrect

getMsgParamSize

public int getMsgParamSize()

Returns:

the number of msgParam values.

getObjectName

public RuleName getObjectName()

Returns:

The name of this object from the ruleName attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Returns:

The ruleName attribute.