CheckAttributesBasedOnValueRuleDataDMW (dark-matter 3.1.15 API)

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

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF
```
public class CheckAttributesBasedOnValueRuleDataDMW
extends RuleData
implements DmcNamedObjectIF
```
The CheckAttributesBasedOnValueRule allows you to specify\n that certain optional attributes must exist (or not exist) based on the value\n of another single valued attribute in an object. This allows for finer control of must/may\n attributes based on other values in an object. An example usage (from\n the dark-matter validation schema) looks like:\n
```
\n CheckAttributesBasedOnValueRuleData\n ruleName             
 dmvNoMustInExtensible\n ruleTitle             If a ClassDefinition's
 classType is AUXILIARY, it can't have mandatory attributes\n applyToClass 
         ClassDefinition\n basedOnAttribute      classType\n basedOnValue  
        AUXILIARY\n excludeThisAttribute  must\n description           An
 AUXILIARY class can be added to an object dynamically and\n  we don't
 allow mandatory attributes in such classes.\n 
```
\n If the basedOnAttribute doesn't exist in the object being validated, the rule does nothing.
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
	`CheckAttributesBasedOnValueRuleDataDMW()`
	`CheckAttributesBasedOnValueRuleDataDMW(CheckAttributesBasedOnValueRuleDataDMO obj)`
`protected`	`CheckAttributesBasedOnValueRuleDataDMW(CheckAttributesBasedOnValueRuleDataDMO obj, ClassDefinition cd)`
	`CheckAttributesBasedOnValueRuleDataDMW(DmcTypeModifierMV mods)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBasedOnValue(Object value)` Adds another basedOnValue value.
`void`	`addBasedOnValue(String value)` Adds another basedOnValue value.
`void`	`addDescription(Object value)` Adds another description value.
`void`	`addDescription(String value)` Adds another description value.
`DmcAttribute<?>`	`addExcludeThisAttribute(AttributeDefinition value)` Adds another excludeThisAttribute value.
`DmcAttribute<?>`	`addIncludeThisAttribute(AttributeDefinition value)` Adds another includeThisAttribute value.
`boolean`	`basedOnValueContains(String value)`
`CheckAttributesBasedOnValueRuleDataDMW`	`cloneIt()`
`void`	`delBasedOnValue(Object value)` Deletes a basedOnValue value.
`void`	`delBasedOnValue(String value)` Deletes a basedOnValue value.
`void`	`delDescription(Object value)` Deletes a description value.
`void`	`delDescription(String value)` Deletes a description value.
`void`	`delExcludeThisAttribute(AttributeDefinition value)` Deletes a excludeThisAttribute value.
`void`	`delIncludeThisAttribute(AttributeDefinition value)` Deletes a includeThisAttribute 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.
`AttributeDefinition`	`getBasedOnAttribute()`
`HashSet<String>`	`getBasedOnValueCopy()`
`boolean`	`getBasedOnValueHasValue()`
`boolean`	`getBasedOnValueIsEmpty()`
`StringIterableDMW`	`getBasedOnValueIterable()`
`int`	`getBasedOnValueSize()`
`ArrayList<String>`	`getDescriptionCopy()`
`boolean`	`getDescriptionHasValue()`
`boolean`	`getDescriptionIsEmpty()`
`StringIterableDMW`	`getDescriptionIterable()`
`int`	`getDescriptionSize()`
`CheckAttributesBasedOnValueRuleDataDMO`	`getDMO()`
`ArrayList<AttributeDefinition>`	`getExcludeThisAttributeCopy()`
`boolean`	`getExcludeThisAttributeHasValue()`
`boolean`	`getExcludeThisAttributeIsEmpty()`
`AttributeDefinitionIterableDMW`	`getExcludeThisAttributeIterable()`
`int`	`getExcludeThisAttributeSize()`
`ArrayList<AttributeDefinition>`	`getIncludeThisAttributeCopy()`
`boolean`	`getIncludeThisAttributeHasValue()`
`boolean`	`getIncludeThisAttributeIsEmpty()`
`AttributeDefinitionIterableDMW`	`getIncludeThisAttributeIterable()`
`int`	`getIncludeThisAttributeSize()`
`CheckAttributesBasedOnValueRuleDataDMW`	`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`	`remBasedOnAttribute()` Removes the basedOnAttribute attribute value.
`void`	`remBasedOnValue()` Removes the basedOnValue attribute value.
`void`	`remDescription()` Removes the description attribute value.
`void`	`remExcludeThisAttribute()` Removes the excludeThisAttribute attribute value.
`void`	`remIncludeThisAttribute()` Removes the includeThisAttribute attribute value.
`void`	`remRuleName()` Removes the ruleName attribute value.
`void`	`remRuleTitle()` Removes the ruleTitle attribute value.
`void`	`setBasedOnAttribute(AttributeDefinition value)` Sets the basedOnAttribute to the specified value.
`void`	`setBasedOnAttribute(Object value)` Sets the basedOnAttribute 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
  - CheckAttributesBasedOnValueRuleDataDMW
```
public CheckAttributesBasedOnValueRuleDataDMW()
```
  - CheckAttributesBasedOnValueRuleDataDMW
```
public CheckAttributesBasedOnValueRuleDataDMW(DmcTypeModifierMV mods)
```
  - CheckAttributesBasedOnValueRuleDataDMW
```
public CheckAttributesBasedOnValueRuleDataDMW(CheckAttributesBasedOnValueRuleDataDMO obj)
```
  - CheckAttributesBasedOnValueRuleDataDMW
```
protected CheckAttributesBasedOnValueRuleDataDMW(CheckAttributesBasedOnValueRuleDataDMO obj,
                                                 ClassDefinition cd)
```
- Method Detail
  - getModificationRecorder
```
public CheckAttributesBasedOnValueRuleDataDMW getModificationRecorder()
```
  - cloneIt
```
public CheckAttributesBasedOnValueRuleDataDMW cloneIt()
```
  - getDMO
```
public CheckAttributesBasedOnValueRuleDataDMO 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.
  - getBasedOnAttribute
```
public AttributeDefinition getBasedOnAttribute()
```
    Returns:
    
    A AttributeDefinition object.
  - setBasedOnAttribute
```
public void setBasedOnAttribute(AttributeDefinition value)
```
    Sets the basedOnAttribute to the specified value.
    
    Parameters:
    
    value - A value compatible with AttributeDefinitionREF
  - setBasedOnAttribute
```
public void setBasedOnAttribute(Object value)
                         throws DmcValueException
```
    Sets the basedOnAttribute to the specified value.
    
    Parameters:
    
    value - A value compatible with AttributeDefinitionREF
    
    Throws:
    
    DmcValueException - is the value is incorrect
  - remBasedOnAttribute
```
public void remBasedOnAttribute()
```
    Removes the basedOnAttribute attribute value.
  - getBasedOnValueSize
```
public int getBasedOnValueSize()
```
    Returns:
    
    The number of String items.
  - getBasedOnValueIsEmpty
```
public boolean getBasedOnValueIsEmpty()
```
    Returns:
    
    true if there are no StringDMO items.
  - getBasedOnValueHasValue
```
public boolean getBasedOnValueHasValue()
```
    Returns:
    
    true if there are any StringDMO items.
  - getBasedOnValueIterable
```
public StringIterableDMW getBasedOnValueIterable()
```
    Returns:
    
    An Iterator of String objects.
  - addBasedOnValue
```
public void addBasedOnValue(Object value)
                     throws DmcValueException
```
    Adds another basedOnValue value.
    
    Parameters:
    
    value - A value compatible with String
    
    Throws:
    
    DmcValueException - if value is incorrect
  - addBasedOnValue
```
public void addBasedOnValue(String value)
```
    Adds another basedOnValue value.
    
    Parameters:
    
    value - A value compatible with String
  - basedOnValueContains
```
public boolean basedOnValueContains(String value)
```
    Parameters:
    
    value - A value compatible with String
    
    Returns:
    
    true if the collection contains the basedOnValue value.
  - getBasedOnValueCopy
```
public HashSet<String> getBasedOnValueCopy()
```
    Returns:
    
    A COPY of the collection of String objects.
  - delBasedOnValue
```
public void delBasedOnValue(Object value)
                     throws DmcValueException
```
    Deletes a basedOnValue value.
    
    Parameters:
    
    value - The String to be deleted from set of attribute values.
    
    Throws:
    
    DmcValueException - if value is incorrect
  - delBasedOnValue
```
public void delBasedOnValue(String value)
```
    Deletes a basedOnValue value.
    
    Parameters:
    
    value - The String to be deleted from set of attribute values.
  - remBasedOnValue
```
public void remBasedOnValue()
```
    Removes the basedOnValue 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.
  - getExcludeThisAttributeSize
```
public int getExcludeThisAttributeSize()
```
    Returns:
    
    The number of AttributeDefinition items.
  - getExcludeThisAttributeIsEmpty
```
public boolean getExcludeThisAttributeIsEmpty()
```
    Returns:
    
    true if there are no AttributeDefinitionDMO items.
  - getExcludeThisAttributeHasValue
```
public boolean getExcludeThisAttributeHasValue()
```
    Returns:
    
    true if there are any AttributeDefinitionDMO items.
  - getExcludeThisAttributeIterable
```
public AttributeDefinitionIterableDMW getExcludeThisAttributeIterable()
```
    Returns:
    
    An Iterator of AttributeDefinitionDMO objects.
  - addExcludeThisAttribute
```
public DmcAttribute<?> addExcludeThisAttribute(AttributeDefinition value)
```
    Adds another excludeThisAttribute value.
    
    Parameters:
    
    value - A value compatible with AttributeDefinition
    
    Returns:
    
    the attribute instance
  - delExcludeThisAttribute
```
public void delExcludeThisAttribute(AttributeDefinition value)
```
    Deletes a excludeThisAttribute value.
    
    Parameters:
    
    value - The AttributeDefinition to be deleted from set of attribute values.
  - getExcludeThisAttributeCopy
```
public ArrayList<AttributeDefinition> getExcludeThisAttributeCopy()
```
    Returns:
    
    A COPY of the collection of AttributeDefinition objects.
  - remExcludeThisAttribute
```
public void remExcludeThisAttribute()
```
    Removes the excludeThisAttribute attribute value.
  - getIncludeThisAttributeSize
```
public int getIncludeThisAttributeSize()
```
    Returns:
    
    The number of AttributeDefinition items.
  - getIncludeThisAttributeIsEmpty
```
public boolean getIncludeThisAttributeIsEmpty()
```
    Returns:
    
    true if there are no AttributeDefinitionDMO items.
  - getIncludeThisAttributeHasValue
```
public boolean getIncludeThisAttributeHasValue()
```
    Returns:
    
    true if there are any AttributeDefinitionDMO items.
  - getIncludeThisAttributeIterable
```
public AttributeDefinitionIterableDMW getIncludeThisAttributeIterable()
```
    Returns:
    
    An Iterator of AttributeDefinitionDMO objects.
  - addIncludeThisAttribute
```
public DmcAttribute<?> addIncludeThisAttribute(AttributeDefinition value)
```
    Adds another includeThisAttribute value.
    
    Parameters:
    
    value - A value compatible with AttributeDefinition
    
    Returns:
    
    the attribute instance
  - delIncludeThisAttribute
```
public void delIncludeThisAttribute(AttributeDefinition value)
```
    Deletes a includeThisAttribute value.
    
    Parameters:
    
    value - The AttributeDefinition to be deleted from set of attribute values.
  - getIncludeThisAttributeCopy
```
public ArrayList<AttributeDefinition> getIncludeThisAttributeCopy()
```
    Returns:
    
    A COPY of the collection of AttributeDefinition objects.
  - remIncludeThisAttribute
```
public void remIncludeThisAttribute()
```
    Removes the includeThisAttribute 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.

Class CheckAttributesBasedOnValueRuleDataDMW

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

Constructor Summary

Method Summary

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

Methods inherited from class org.dmd.dmw.DmwWrapper

Methods inherited from class org.dmd.dmc.DmcContainer

Methods inherited from class java.lang.Object

Constructor Detail

CheckAttributesBasedOnValueRuleDataDMW

CheckAttributesBasedOnValueRuleDataDMW

CheckAttributesBasedOnValueRuleDataDMW

CheckAttributesBasedOnValueRuleDataDMW

Method Detail

getModificationRecorder

cloneIt

getDMO

getObjectName

hashCode

getObjectNameAttribute

equals

getBasedOnAttribute

setBasedOnAttribute

setBasedOnAttribute

remBasedOnAttribute

getBasedOnValueSize

getBasedOnValueIsEmpty

getBasedOnValueHasValue

getBasedOnValueIterable

addBasedOnValue

addBasedOnValue

basedOnValueContains

getBasedOnValueCopy

delBasedOnValue

delBasedOnValue

remBasedOnValue

getDescriptionSize

getDescriptionIsEmpty

getDescriptionHasValue

getDescriptionIterable

addDescription

addDescription

descriptionContains

getDescriptionCopy

delDescription

delDescription

remDescription

getExcludeThisAttributeSize

getExcludeThisAttributeIsEmpty

getExcludeThisAttributeHasValue

getExcludeThisAttributeIterable

addExcludeThisAttribute

delExcludeThisAttribute

getExcludeThisAttributeCopy

remExcludeThisAttribute

getIncludeThisAttributeSize

getIncludeThisAttributeIsEmpty

getIncludeThisAttributeHasValue

getIncludeThisAttributeIterable

addIncludeThisAttribute

delIncludeThisAttribute

getIncludeThisAttributeCopy

remIncludeThisAttribute

getRuleName

setRuleName

setRuleName

remRuleName

getRuleTitle

setRuleTitle

setRuleTitle

remRuleTitle