org.dmd.dmv.server.generated.dmw

Class RestrictReferencesRuleDataDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.RuleDataDMW

org.dmd.dms.RuleData

org.dmd.dmv.server.generated.dmw.RestrictReferencesRuleDataDMW

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF

public class RestrictReferencesRuleDataDMW
extends RuleData
implements DmcNamedObjectIF

The RestrictReferencesRule allows you to restrict the types\n of objects being referenced via a reference attribute. This is useful in situations\n where a single reference attribute is being used in multiple contexts and you\n want to restrict the types of objects it references in those contexts.\n

\n Example:\n

\n RestrictReferencesRuleData\n ruleName
           rrrDerivedA\n ruleTitle          The X attribute can only refer
 to other objects of type SomeClassA and SomeClassB when used in a
 SomeOtherClass instance.\n applyToAttribute   X\n applyToClass
                SomeOtherClass\n allowedReference       SomeClassA\n
 allowedReference       SomeClassB\n 

Generated from the dmv schema at version 0.1

This code was auto-generated by the dmggenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dmg.generators.BaseDMWGenerator.dumpWrapper(BaseDMWGenerator.java:488)

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	RestrictReferencesRuleDataDMW()
	RestrictReferencesRuleDataDMW(DmcTypeModifierMV mods)
	RestrictReferencesRuleDataDMW(RestrictReferencesRuleDataDMO obj)
protected	RestrictReferencesRuleDataDMW(RestrictReferencesRuleDataDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addAllowedReference(ClassDefinition value) Adds another allowedReference value.
void	addDescription(Object value) Adds another description value.
void	addDescription(String value) Adds another description value.
RestrictReferencesRuleDataDMW	cloneIt()
void	delAllowedReference(ClassDefinition value) Deletes a allowedReference value.
void	delDescription(Object value) Deletes a description value.
void	delDescription(String value) Deletes a description value.
boolean	descriptionContains(String value)
boolean	equals(Object obj) This method should check the type of the obj param and compare the name of this object with the one passed as argument.
ArrayList<ClassDefinition>	getAllowedReferenceCopy()
boolean	getAllowedReferenceHasValue()
boolean	getAllowedReferenceIsEmpty()
ClassDefinitionIterableDMW	getAllowedReferenceIterable()
int	getAllowedReferenceSize()
AttributeDefinition	getApplyToAttribute()
ArrayList<String>	getDescriptionCopy()
boolean	getDescriptionHasValue()
boolean	getDescriptionIsEmpty()
StringIterableDMW	getDescriptionIterable()
int	getDescriptionSize()
RestrictReferencesRuleDataDMO	getDMO()
RestrictReferencesRuleDataDMW	getModificationRecorder()
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.
int	hashCode()
void	remAllowedReference() Removes the allowedReference attribute value.
void	remApplyToAttribute() Removes the applyToAttribute attribute value.
void	remDescription() Removes the description attribute value.
void	remRuleName() Removes the ruleName attribute value.
void	remRuleTitle() Removes the ruleTitle attribute value.
void	setApplyToAttribute(AttributeDefinition value) Sets the applyToAttribute to the specified value.
void	setApplyToAttribute(Object value) Sets the applyToAttribute to the specified value.
void	setRuleName(Object value) Sets ruleName to the specified value.
void	setRuleName(RuleName value) Sets ruleName to the specified value.
void	setRuleTitle(Object value) Sets ruleTitle to the specified value.
void	setRuleTitle(String value) Sets ruleTitle to the specified value.

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

addMsgParam, getApplyToClass, getDefinedIn, getDescription, getDescriptionWithNewlines, getFile, getImmediateHalt, getLineNumber, getMsgKey, getMsgParam, getMsgParamSize, setApplyToClass, setDefinedIn, setDmcObject, setFile, setImmediateHalt, setLineNumber, setMsgKey

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RestrictReferencesRuleDataDMW

public RestrictReferencesRuleDataDMW()

RestrictReferencesRuleDataDMW

public RestrictReferencesRuleDataDMW(DmcTypeModifierMV mods)

RestrictReferencesRuleDataDMW

public RestrictReferencesRuleDataDMW(RestrictReferencesRuleDataDMO obj)

RestrictReferencesRuleDataDMW

protected RestrictReferencesRuleDataDMW(RestrictReferencesRuleDataDMO obj,
                                        ClassDefinition cd)

Method Detail

getModificationRecorder

public RestrictReferencesRuleDataDMW getModificationRecorder()

cloneIt

public RestrictReferencesRuleDataDMW cloneIt()

getDMO

public RestrictReferencesRuleDataDMO getDMO()

Overrides:

getDMO in class RuleDataDMW

getObjectName

public RuleName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class RuleDataDMW

Returns:

The name of this object from the ruleName attribute.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class RuleDataDMW

Returns:

The ruleName attribute.

equals

public boolean equals(Object obj)

Description copied from interface: DmcNamedObjectIF

This method should check the type of the obj param and compare the name of this object with the one passed as argument.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class DmwWrapper

Parameters:

obj - The comparison object.

Returns:

True if the names match.

getAllowedReferenceSize

public int getAllowedReferenceSize()

Returns:

The number of ClassDefinition items.

getAllowedReferenceIsEmpty

public boolean getAllowedReferenceIsEmpty()

Returns:

true if there are no ClassDefinitionDMO items.

getAllowedReferenceHasValue

public boolean getAllowedReferenceHasValue()

Returns:

true if there are any ClassDefinitionDMO items.

getAllowedReferenceIterable

public ClassDefinitionIterableDMW getAllowedReferenceIterable()

Returns:

An Iterator of ClassDefinitionDMO objects.

addAllowedReference

public DmcAttribute<?> addAllowedReference(ClassDefinition value)

Adds another allowedReference value.

Parameters:

value - A value compatible with ClassDefinition

Returns:

the attribute instance

delAllowedReference

public void delAllowedReference(ClassDefinition value)

Deletes a allowedReference value.

Parameters:

value - The ClassDefinition to be deleted from set of attribute values.

getAllowedReferenceCopy

public ArrayList<ClassDefinition> getAllowedReferenceCopy()

Returns:

A COPY of the collection of ClassDefinition objects.

remAllowedReference

public void remAllowedReference()

Removes the allowedReference attribute value.

getApplyToAttribute

public AttributeDefinition getApplyToAttribute()

Returns:

A AttributeDefinition object.

setApplyToAttribute

public void setApplyToAttribute(AttributeDefinition value)

Sets the applyToAttribute to the specified value.

Parameters:

value - A value compatible with AttributeDefinitionREF

setApplyToAttribute

public void setApplyToAttribute(Object value)
                         throws DmcValueException

Sets the applyToAttribute to the specified value.

Parameters:

value - A value compatible with AttributeDefinitionREF

Throws:

DmcValueException - is the value is incorrect

remApplyToAttribute

public void remApplyToAttribute()

Removes the applyToAttribute attribute value.

getDescriptionSize

public int getDescriptionSize()

Overrides:

getDescriptionSize in class RuleDataDMW

Returns:

The number of String items.

getDescriptionIsEmpty

public boolean getDescriptionIsEmpty()

Returns:

true if there are no StringDMO items.

getDescriptionHasValue

public boolean getDescriptionHasValue()

Returns:

true if there are any StringDMO items.

getDescriptionIterable

public StringIterableDMW getDescriptionIterable()

Returns:

An Iterator of String objects.

addDescription

public void addDescription(Object value)
                    throws DmcValueException

Adds another description value.

Overrides:

addDescription in class RuleDataDMW

Parameters:

value - A value compatible with String

Throws:

DmcValueException - if value is incorrect

addDescription

public void addDescription(String value)

Adds another description value.

Parameters:

value - A value compatible with String

descriptionContains

public boolean descriptionContains(String value)

Parameters:

value - A value compatible with String

Returns:

true if the collection contains the description value.

getDescriptionCopy

public ArrayList<String> getDescriptionCopy()

Returns:

A COPY of the collection of String objects.

delDescription

public void delDescription(Object value)
                    throws DmcValueException

Deletes a description value.

Parameters:

value - The String to be deleted from set of attribute values.

Throws:

DmcValueException - if value is incorrect

delDescription

public void delDescription(String value)

Deletes a description value.

Parameters:

value - The String to be deleted from set of attribute values.

remDescription

public void remDescription()

Removes the description attribute value.

getRuleName

public RuleName getRuleName()

Description copied from class: RuleDataDMW

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.

Overrides:

getRuleName in class RuleDataDMW

Returns:

the RuleName

setRuleName

public void setRuleName(Object value)
                 throws DmcValueException

Sets ruleName to the specified value.

Overrides:

setRuleName in class RuleDataDMW

Parameters:

value - A value compatible with DmcTypeRuleName

Throws:

DmcValueException - if the value is incorrect

setRuleName

public void setRuleName(RuleName value)

Sets ruleName to the specified value.

Parameters:

value - RuleName

remRuleName

public void remRuleName()

Removes the ruleName attribute value.

getRuleTitle

public String getRuleTitle()

Description copied from class: RuleDataDMW

The title of a rule.

Overrides:

getRuleTitle in class RuleDataDMW

Returns:

the String

setRuleTitle

public void setRuleTitle(Object value)
                  throws DmcValueException

Sets ruleTitle to the specified value.

Overrides:

setRuleTitle in class RuleDataDMW

Parameters:

value - A value compatible with DmcTypeString

Throws:

DmcValueException - if the value is incorrect

setRuleTitle

public void setRuleTitle(String value)

Sets ruleTitle to the specified value.

Parameters:

value - String

remRuleTitle

public void remRuleTitle()

Removes the ruleTitle attribute value.