org.dmd.dms.generated.dmw

Class RuleCategoryDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.DSDefinitionDMW

org.dmd.dms.DSDefinition

org.dmd.dms.generated.dmw.DmsDefinitionDMW

org.dmd.dms.DmsDefinition

org.dmd.dms.generated.dmw.RuleCategoryDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

RuleCategory

public class RuleCategoryDMW
extends DmsDefinition
implements DmcDefinitionIF

The RuleCategory allows for the definition of categories of rules to be applied\n to various objects and indicates the expected interface to be implemented by a rule instance.\n A RuleDefinition may belong to multiple categories. \n

\n RuleCategories fall into two broad types, ATTRIBUTE and CLASS level, as specified via the ruleType\n attribute. When a RuleDefinition belongs to an ATTRIBUTE level category, its instances will have\n a mandatory applyToAttribute attribute. Both ATTRIBUTE and CLASS level RuleDefinitions have an optional\n applyToClass attribute by default.\n

\n Specifying a RuleCategory will cause the generation of several artifacts including:\n

\n
• a category interface: this interface will be created based on the ruleParam values and will be\n implemented by RuleDefinitions that are part of the category\n
a rule collection: this is a category specific collection of rules that organize the rule instances\n in this category.\n

\n Exactly how a RuleCategory applies rule instances is category specific and this behaviour should be\n part of the description of a rule category.\n

\n For CLASS level rules, you must specify the classInfoFromParam attribute to indicate how to \n get the DmcClassInfo from whatever object you are passing to the rule. For ATTRIBUTE level rules,\n you must specify both attributeInfoFromParam and classInfoFromParam.

Author:

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

Field Summary

Fields inherited from class org.dmd.dms.DmsDefinition

metaname

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuleCategoryDMW()
protected	RuleCategoryDMW(ClassDefinition cd)
protected	RuleCategoryDMW(DmcObject obj)
protected	RuleCategoryDMW(DmcObject obj, ClassDefinition cd)
protected	RuleCategoryDMW(String mn)

Method Summary

Modifier and Type	Method and Description
void	addRuleImport(Object value) Adds another ruleImport value.
void	addRuleParam(Object value) Adds another ruleParam value.
String	getAttributeInfoFromParam() Indicates how the DmcAttributeInfo should be extracted from one of the ruleParam values\n associated with a RuleCategory.
String	getClassInfoFromParam() Indicates how the DmcClassInfo should be extracted from one of the ruleParam values\n associated with a RuleCategory.
RuleCategoryDMO	getDMO()
DefinitionName	getName() The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
OperationalContextEnum	getOpContext() Indicates the operational context for some component e.g.
Integer	getRuleCategoryID() The numeric ID of a rule category.
Iterator<String>	getRuleImport() An import required for generation of the rule collection associated with\n a RuleCategory.
int	getRuleImportSize()
Iterator<RuleParam>	getRuleParam() A parameter to be supplied to a rule when it is executed.
int	getRuleParamSize()
RuleTypeEnum	getRuleType() The type of a rule.
void	setAttributeInfoFromParam(Object value) Sets attributeInfoFromParam to the specified value.
void	setClassInfoFromParam(Object value) Sets classInfoFromParam to the specified value.
void	setDmcObject(DmcObject obj) Sets the core object.
void	setName(Object value) Sets name to the specified value.
void	setOpContext(Object value) Sets opContext to the specified value.
void	setRuleCategoryID(Object value) Sets ruleCategoryID to the specified value.
void	setRuleType(Object value) Sets ruleType to the specified value.

Methods inherited from class org.dmd.dms.DmsDefinition

getDmcObject

Methods inherited from class org.dmd.dms.generated.dmw.DmsDefinitionDMW

addRelatedToConcept, getRelatedToConcept, getRelatedToConceptSize

Methods inherited from class org.dmd.dms.DSDefinition

equals, getFullDotName, getNameOfModuleWhereThisCameFrom

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionDMW

addComment, addDescription, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDefinedIn, getDescription, getDescriptionSize, getDescriptionWithNewlines, getDmoFromModule, getDotName, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, getWhy, setDefinedIn, setDmoFromModule, setDotName, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, 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.definitions.DmcDefinitionIF

getDefinedIn, getDotName, toOIF

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

equals

Constructor Detail

RuleCategoryDMW

protected RuleCategoryDMW()

RuleCategoryDMW

protected RuleCategoryDMW(DmcObject obj)

RuleCategoryDMW

protected RuleCategoryDMW(DmcObject obj,
                          ClassDefinition cd)

RuleCategoryDMW

protected RuleCategoryDMW(ClassDefinition cd)

RuleCategoryDMW

protected RuleCategoryDMW(String mn)
                   throws DmcValueException

Throws:

DmcValueException

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 DmsDefinition

Parameters:

obj - The core object.

getDMO

public RuleCategoryDMO getDMO()

Overrides:

getDMO in class DmsDefinitionDMW

getName

public DefinitionName getName()

The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part. A name starts with a letter followed\n by letters and numbers.

Specified by:

getName in interface DmcDefinitionIF

Overrides:

getName in class DmsDefinitionDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class DmsDefinitionDMW

Parameters:

value - A value compatible with DmcTypeDefinitionNameSV

Throws:

DmcValueException - if the value is incorrect

getOpContext

public OperationalContextEnum getOpContext()

Indicates the operational context for some component e.g. object or attribute\n validators.

Returns:

the OperationalContextEnum

setOpContext

public void setOpContext(Object value)
                  throws DmcValueException

Sets opContext to the specified value.

Parameters:

value - A value compatible with DmcTypeOperationalContextEnumSV

Throws:

DmcValueException - if the value is incorrect

getRuleCategoryID

public Integer getRuleCategoryID()

The numeric ID of a rule category. Category IDs must be unique for all RuleDefinitions defined\n within a schema.

Returns:

the Integer

setRuleCategoryID

public void setRuleCategoryID(Object value)
                       throws DmcValueException

Sets ruleCategoryID to the specified value.

Parameters:

value - A value compatible with DmcTypeIntegerSV

Throws:

DmcValueException - if the value is incorrect

getRuleType

public RuleTypeEnum getRuleType()

The type of a rule.

Returns:

the RuleTypeEnum

setRuleType

public void setRuleType(Object value)
                 throws DmcValueException

Sets ruleType to the specified value.

Parameters:

value - A value compatible with DmcTypeRuleTypeEnumSV

Throws:

DmcValueException - if the value is incorrect

getRuleParam

public Iterator<RuleParam> getRuleParam()

A parameter to be supplied to a rule when it is executed.

Returns:

the RuleParam

addRuleParam

public void addRuleParam(Object value)
                  throws DmcValueException

Adds another ruleParam value.

Parameters:

value - A value compatible with DmcTypeRuleParamMV

Throws:

DmcValueException - if the value is incorrect

getRuleParamSize

public int getRuleParamSize()

Returns:

the number of ruleParam values.

getClassInfoFromParam

public String getClassInfoFromParam()

Indicates how the DmcClassInfo should be extracted from one of the ruleParam values\n associated with a RuleCategory. If additional classes are required to support this access, you can specify ruleImport\n values as appropriate.

Returns:

the String

setClassInfoFromParam

public void setClassInfoFromParam(Object value)
                           throws DmcValueException

Sets classInfoFromParam to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getRuleImport

public Iterator<String> getRuleImport()

An import required for generation of the rule collection associated with\n a RuleCategory.

Returns:

the String

addRuleImport

public void addRuleImport(Object value)
                   throws DmcValueException

Adds another ruleImport value.

Parameters:

value - A value compatible with DmcTypeStringMV

Throws:

DmcValueException - if the value is incorrect

getRuleImportSize

public int getRuleImportSize()

Returns:

the number of ruleImport values.

getAttributeInfoFromParam

public String getAttributeInfoFromParam()

Indicates how the DmcAttributeInfo should be extracted from one of the ruleParam values\n associated with a RuleCategory. If additional classes are required to support this access, you can specify ruleImport\n values as appropriate.

Returns:

the String

setAttributeInfoFromParam

public void setAttributeInfoFromParam(Object value)
                               throws DmcValueException

Sets attributeInfoFromParam to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class DmsDefinition

Returns:

The name of this object from the name attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class DmsDefinitionDMW

Returns:

The name attribute.