org.dmd.dmv.server.generated.dmw

Class OneOfTheseAttributesRequiredRuleDataDMW

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.OneOfTheseAttributesRequiredRuleDataDMW

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF

public class OneOfTheseAttributesRequiredRuleDataDMW
extends RuleData
implements DmcNamedObjectIF

The OneOfTheseAttributesRequiredRule allows you to specify\n that one of the possible optional attributes specified must be present\n in the object being checked.\n

\n If only one of the possibilities is allowed, you can specify the andOnlyOne\n flag and set it to true. In this case only one of the possibilities will be allowed.\n

\n An example of this rule can be seen below.\n

\n OneOfTheseAttributesRequiredRuleData\n
 ruleName                       dmvIncludeOrExclude\n ruleTitle                 At least one of the
 excludeThisAttribute or includeThisAttribute attributes must be
 specified.\n applyToClass              CheckAttributesBasedOnValueRuleData\n
 onePossibility         excludeThisAttribute\n
 onePossibility         includeThisAttribute\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
	OneOfTheseAttributesRequiredRuleDataDMW()
	OneOfTheseAttributesRequiredRuleDataDMW(DmcTypeModifierMV mods)
	OneOfTheseAttributesRequiredRuleDataDMW(OneOfTheseAttributesRequiredRuleDataDMO obj)
protected	OneOfTheseAttributesRequiredRuleDataDMW(OneOfTheseAttributesRequiredRuleDataDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addDescription(Object value) Adds another description value.
void	addDescription(String value) Adds another description value.
DmcAttribute<?>	addOnePossibility(AttributeDefinition value) Adds another onePossibility value.
OneOfTheseAttributesRequiredRuleDataDMW	cloneIt()
void	delDescription(Object value) Deletes a description value.
void	delDescription(String value) Deletes a description value.
void	delOnePossibility(AttributeDefinition value) Deletes a onePossibility 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<String>	getDescriptionCopy()
boolean	getDescriptionHasValue()
boolean	getDescriptionIsEmpty()
StringIterableDMW	getDescriptionIterable()
int	getDescriptionSize()
OneOfTheseAttributesRequiredRuleDataDMO	getDMO()
OneOfTheseAttributesRequiredRuleDataDMW	getModificationRecorder()
RuleName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
ArrayList<AttributeDefinition>	getOnePossibilityCopy()
boolean	getOnePossibilityHasValue()
boolean	getOnePossibilityIsEmpty()
AttributeDefinitionIterableDMW	getOnePossibilityIterable()
int	getOnePossibilitySize()
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()
Boolean	isAndOnlyOne()
void	remAndOnlyOne() Removes the andOnlyOne attribute value.
void	remDescription() Removes the description attribute value.
void	remOnePossibility() Removes the onePossibility attribute value.
void	remRuleName() Removes the ruleName attribute value.
void	remRuleTitle() Removes the ruleTitle attribute value.
void	setAndOnlyOne(Boolean value) Sets andOnlyOne to the specified value.
void	setAndOnlyOne(Object value) Sets andOnlyOne 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

OneOfTheseAttributesRequiredRuleDataDMW

public OneOfTheseAttributesRequiredRuleDataDMW()

OneOfTheseAttributesRequiredRuleDataDMW

public OneOfTheseAttributesRequiredRuleDataDMW(DmcTypeModifierMV mods)

OneOfTheseAttributesRequiredRuleDataDMW

public OneOfTheseAttributesRequiredRuleDataDMW(OneOfTheseAttributesRequiredRuleDataDMO obj)

OneOfTheseAttributesRequiredRuleDataDMW

protected OneOfTheseAttributesRequiredRuleDataDMW(OneOfTheseAttributesRequiredRuleDataDMO obj,
                                                  ClassDefinition cd)

Method Detail

getModificationRecorder

public OneOfTheseAttributesRequiredRuleDataDMW getModificationRecorder()

cloneIt

public OneOfTheseAttributesRequiredRuleDataDMW cloneIt()

getDMO

public OneOfTheseAttributesRequiredRuleDataDMO 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.

isAndOnlyOne

public Boolean isAndOnlyOne()

setAndOnlyOne

public void setAndOnlyOne(Object value)
                   throws DmcValueException

Sets andOnlyOne to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

DmcValueException

setAndOnlyOne

public void setAndOnlyOne(Boolean value)

Sets andOnlyOne to the specified value.

Parameters:

value - Boolean

remAndOnlyOne

public void remAndOnlyOne()

Removes the andOnlyOne 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.

getOnePossibilitySize

public int getOnePossibilitySize()

Returns:

The number of AttributeDefinition items.

getOnePossibilityIsEmpty

public boolean getOnePossibilityIsEmpty()

Returns:

true if there are no AttributeDefinitionDMO items.

getOnePossibilityHasValue

public boolean getOnePossibilityHasValue()

Returns:

true if there are any AttributeDefinitionDMO items.

getOnePossibilityIterable

public AttributeDefinitionIterableDMW getOnePossibilityIterable()

Returns:

An Iterator of AttributeDefinitionDMO objects.

addOnePossibility

public DmcAttribute<?> addOnePossibility(AttributeDefinition value)

Adds another onePossibility value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

delOnePossibility

public void delOnePossibility(AttributeDefinition value)

Deletes a onePossibility value.

Parameters:

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

getOnePossibilityCopy

public ArrayList<AttributeDefinition> getOnePossibilityCopy()

Returns:

A COPY of the collection of AttributeDefinition objects.

remOnePossibility

public void remOnePossibility()

Removes the onePossibility 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.