org.dmd.dmv.shared.generated.dmo

Class CheckAttributesBasedOnValueRuleDataDMO

java.lang.Object

org.dmd.dmc.DmcObject

org.dmd.dms.generated.dmo.RuleDataDMO

org.dmd.dmv.shared.generated.dmo.CheckAttributesBasedOnValueRuleDataDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF

public class CheckAttributesBasedOnValueRuleDataDMO
extends RuleDataDMO
implements DmcNamedObjectIF, Serializable

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 dmogenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dms.util.DmoFormatter.dumpDMO(DmoFormatter.java:134)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	constructionClassName

Fields inherited from class org.dmd.dmc.DmcObject

__objectClass, attributes

Constructor Summary

Constructors

Modifier	Constructor and Description
	CheckAttributesBasedOnValueRuleDataDMO()
	CheckAttributesBasedOnValueRuleDataDMO(DmcTypeModifierMV mods)
protected	CheckAttributesBasedOnValueRuleDataDMO(String oc)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addBasedOnValue(Object value) Adds another basedOnValue value.
DmcAttribute<?>	addBasedOnValue(String value) Adds another basedOnValue to the specified value.
DmcAttribute<?>	addDescription(Object value) Adds another description value.
DmcAttribute<?>	addDescription(String value) Adds another description to the specified value.
DmcAttribute<?>	addExcludeThisAttribute(AttributeDefinitionDMO value) Adds another excludeThisAttribute to the specified value.
DmcAttribute<?>	addExcludeThisAttribute(Object value) Adds another excludeThisAttribute value.
DmcAttribute<?>	addIncludeThisAttribute(AttributeDefinitionDMO value) Adds another includeThisAttribute to the specified value.
DmcAttribute<?>	addIncludeThisAttribute(Object value) Adds another includeThisAttribute value.
boolean	basedOnValueContains(String value)
DmcAttribute<?>	delBasedOnValue(Object value) Deletes a basedOnValue value.
DmcAttribute<?>	delBasedOnValue(String value) Deletes a basedOnValue from the specified value.
DmcAttribute<?>	delDescription(Object value) Deletes a description value.
DmcAttribute<?>	delDescription(String value) Deletes a description from the specified value.
DmcAttribute<?>	delExcludeThisAttribute(Object value) Deletes a excludeThisAttribute value.
DmcAttribute<?>	delIncludeThisAttribute(Object value) Deletes a includeThisAttribute value.
boolean	descriptionContains(String value)
boolean	equals(Object obj) This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.
AttributeDefinitionREF	getBasedOnAttribute()
AttributeDefinitionREF	getBasedOnAttributeREF()
Iterator<String>	getBasedOnValue()
int	getBasedOnValueSize()
Iterator<String>	getDescription() The description attribute is used to provide descriptive\n documentation for schema related definitions.
int	getDescriptionSize()
Iterator<AttributeDefinitionREF>	getExcludeThisAttribute()
Iterator<AttributeDefinitionREF>	getExcludeThisAttributeREFs()
int	getExcludeThisAttributeSize()
Iterator<AttributeDefinitionREF>	getIncludeThisAttribute()
Iterator<AttributeDefinitionREF>	getIncludeThisAttributeREFs()
int	getIncludeThisAttributeSize()
CheckAttributesBasedOnValueRuleDataDMO	getModificationRecorder()
CheckAttributesBasedOnValueRuleDataDMO	getNew() Auto-generated derived classes override this to return an empty instance of themselves.
String	getNthBasedOnValue(int i)
String	getNthDescription(int i)
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.
CheckAttributesBasedOnValueRuleDataDMO	getSlice(DmcSliceInfo info) Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
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(AttributeDefinitionDMO value) Sets basedOnAttribute to the specified value.
void	setBasedOnAttribute(Object value) Sets 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.dmo.RuleDataDMO

addMsgParam, getApplyToClass, getDefinedIn, getDescriptionWithNewlines, getFile, getIdToAttrInfo, getImmediateHalt, getLineNumber, getMsgKey, getMsgParam, getStringToAttrInfo, setApplyToClass, setDefinedIn, setFile, setImmediateHalt, setLineNumber, setMsgKey

Methods inherited from class org.dmd.dmc.DmcObject

add, add, addAux, addAux, addBackref, allowsAttribute, applyModifier, clearReferenceInfo, cloneIt, del, del, delFromEmptyAttribute, deserializeIt, get, get, get, getAdditionalAttributes, getAttributeInfo, getAttributeInfo, getAttributeIterator, getAttributeNames, getAttributes, getAttributeValidators, getBackref, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getContainer, getDataType, getFullClassName, getLastValue, getModifier, getObjectClass, getObjectValidators, getReferringObjects, getReferringObjectsViaAttribute, getStagingObject, hasAux, hasValue, isModrec, isReferenced, isStaging, modrec, nth, nthNullFromEmptyAttribute, numberOfAttributes, populateSlice, referenceCount, rem, rem, removeAux, removeBackref, resolveReferences, resolveReferences, resolveReferences, resolveReferencesExceptClass, resolveReferencesExceptClass, serializeIt, set, set, setContainer, setLastValue, setModifier, shallowCopy, staging, supportsBackrefTracking, toCompactJSON, toCompactJSON, toJSON, toJSON, toJSON, toOIF, toOIF, toOIFNoPadding, toPersistentOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

constructionClassName

public static final String constructionClassName

See Also:

Constant Field Values

Constructor Detail

CheckAttributesBasedOnValueRuleDataDMO

public CheckAttributesBasedOnValueRuleDataDMO()

CheckAttributesBasedOnValueRuleDataDMO

protected CheckAttributesBasedOnValueRuleDataDMO(String oc)

CheckAttributesBasedOnValueRuleDataDMO

public CheckAttributesBasedOnValueRuleDataDMO(DmcTypeModifierMV mods)

Method Detail

getNew

public CheckAttributesBasedOnValueRuleDataDMO getNew()

Description copied from class: DmcObject

Auto-generated derived classes override this to return an empty instance of themselves. This supports cloning.

Overrides:

getNew in class RuleDataDMO

Returns:

An instance of the derived class.

getSlice

public CheckAttributesBasedOnValueRuleDataDMO getSlice(DmcSliceInfo info)

Description copied from class: DmcObject

Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes. In the case of named objects, the object name is always part of the slice.

Overrides:

getSlice in class RuleDataDMO

Parameters:

info - the slice info

Returns:

An instance of the derived class with the specified slice of attributes.

getModificationRecorder

public CheckAttributesBasedOnValueRuleDataDMO getModificationRecorder()

getObjectName

public RuleName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class RuleDataDMO

Returns:

The name of this object from the ruleName attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class RuleDataDMO

Returns:

The ruleName attribute.

equals

public boolean equals(Object obj)

Description copied from class: DmcObject

This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class DmcObject

Parameters:

obj - The comparison object.

Returns:

true if we equal the specified object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDescription

public Iterator<String> getDescription()

Description copied from class: RuleDataDMO

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.

Overrides:

getDescription in class RuleDataDMO

Returns:

An Iterator of String objects.

getNthDescription

public String getNthDescription(int i)

Parameters:

i - the index

Returns:

The nth String value.

addDescription

public DmcAttribute<?> addDescription(String value)

Adds another description to the specified value.

Parameters:

value - String

Returns:

the attribute instance

descriptionContains

public boolean descriptionContains(String value)

Parameters:

value - String

Returns:

true if we contain a valued keyed by the specified String.

addDescription

public DmcAttribute<?> addDescription(Object value)
                               throws DmcValueException

Adds another description value.

Overrides:

addDescription in class RuleDataDMO

Parameters:

value - A value compatible with String

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getDescriptionSize

public int getDescriptionSize()

Returns:

the number of values in description

delDescription

public DmcAttribute<?> delDescription(Object value)
                               throws DmcValueException

Deletes a description value.

Parameters:

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

Returns:

the deleted attribute instance

Throws:

DmcValueException - if the value is incorrect

delDescription

public DmcAttribute<?> delDescription(String value)

Deletes a description from the specified value.

Parameters:

value - String

Returns:

the deleted attribute instance

remDescription

public void remDescription()

Removes the description attribute value.

getExcludeThisAttribute

public Iterator<AttributeDefinitionREF> getExcludeThisAttribute()

Returns:

An Iterator of AttributeDefinitionDMO objects.

getExcludeThisAttributeREFs

public Iterator<AttributeDefinitionREF> getExcludeThisAttributeREFs()

Returns:

An Iterator of AttributeDefinitionREFs without attempting lazy resolution (if it's turned on).

addExcludeThisAttribute

public DmcAttribute<?> addExcludeThisAttribute(AttributeDefinitionDMO value)

Adds another excludeThisAttribute to the specified value.

Parameters:

value - AttributeDefinition

Returns:

the attribute instance

addExcludeThisAttribute

public DmcAttribute<?> addExcludeThisAttribute(Object value)
                                        throws DmcValueException

Adds another excludeThisAttribute value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getExcludeThisAttributeSize

public int getExcludeThisAttributeSize()

Returns:

the number of values in excludeThisAttribute

delExcludeThisAttribute

public DmcAttribute<?> delExcludeThisAttribute(Object value)

Deletes a excludeThisAttribute value.

Parameters:

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

Returns:

the deleted attribute instance

remExcludeThisAttribute

public void remExcludeThisAttribute()

Removes the excludeThisAttribute attribute value.

getIncludeThisAttribute

public Iterator<AttributeDefinitionREF> getIncludeThisAttribute()

Returns:

An Iterator of AttributeDefinitionDMO objects.

getIncludeThisAttributeREFs

public Iterator<AttributeDefinitionREF> getIncludeThisAttributeREFs()

Returns:

An Iterator of AttributeDefinitionREFs without attempting lazy resolution (if it's turned on).

addIncludeThisAttribute

public DmcAttribute<?> addIncludeThisAttribute(AttributeDefinitionDMO value)

Adds another includeThisAttribute to the specified value.

Parameters:

value - AttributeDefinition

Returns:

the attribute instance

addIncludeThisAttribute

public DmcAttribute<?> addIncludeThisAttribute(Object value)
                                        throws DmcValueException

Adds another includeThisAttribute value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getIncludeThisAttributeSize

public int getIncludeThisAttributeSize()

Returns:

the number of values in includeThisAttribute

delIncludeThisAttribute

public DmcAttribute<?> delIncludeThisAttribute(Object value)

Deletes a includeThisAttribute value.

Parameters:

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

Returns:

the deleted attribute instance

remIncludeThisAttribute

public void remIncludeThisAttribute()

Removes the includeThisAttribute attribute value.

getRuleName

public RuleName getRuleName()

Description copied from class: RuleDataDMO

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 RuleDataDMO

Returns:

the RuleName

setRuleName

public void setRuleName(RuleName value)

Sets ruleName to the specified value.

Parameters:

value - RuleName

setRuleName

public void setRuleName(Object value)
                 throws DmcValueException

Sets ruleName to the specified value.

Overrides:

setRuleName in class RuleDataDMO

Parameters:

value - A value compatible with DmcTypeRuleNameSV

Throws:

DmcValueException - if value is not correct

remRuleName

public void remRuleName()

Removes the ruleName attribute value.

getRuleTitle

public String getRuleTitle()

Description copied from class: RuleDataDMO

The title of a rule.

Overrides:

getRuleTitle in class RuleDataDMO

Returns:

the String

setRuleTitle

public void setRuleTitle(String value)

Sets ruleTitle to the specified value.

Parameters:

value - String

setRuleTitle

public void setRuleTitle(Object value)
                  throws DmcValueException

Sets ruleTitle to the specified value.

Overrides:

setRuleTitle in class RuleDataDMO

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if value is not correct

remRuleTitle

public void remRuleTitle()

Removes the ruleTitle attribute value.

getBasedOnAttribute

public AttributeDefinitionREF getBasedOnAttribute()

Returns:

the AttributeDefinitionREF

getBasedOnAttributeREF

public AttributeDefinitionREF getBasedOnAttributeREF()

Returns:

the reference to AttributeDefinition without attempting lazy resolution (if turned on).

setBasedOnAttribute

public void setBasedOnAttribute(AttributeDefinitionDMO value)

Sets basedOnAttribute to the specified value.

Parameters:

value - AttributeDefinitionDMO

setBasedOnAttribute

public void setBasedOnAttribute(Object value)
                         throws DmcValueException

Sets basedOnAttribute to the specified value.

Parameters:

value - A value compatible with DmcTypeAttributeDefinitionREFSV

Throws:

DmcValueException - if value is not correct

remBasedOnAttribute

public void remBasedOnAttribute()

Removes the basedOnAttribute attribute value.

getBasedOnValue

public Iterator<String> getBasedOnValue()

Returns:

An Iterator of String objects.

getNthBasedOnValue

public String getNthBasedOnValue(int i)

Parameters:

i - the index

Returns:

The nth String value.

addBasedOnValue

public DmcAttribute<?> addBasedOnValue(String value)

Adds another basedOnValue to the specified value.

Parameters:

value - String

Returns:

the attribute instance

basedOnValueContains

public boolean basedOnValueContains(String value)

Parameters:

value - String

Returns:

true if we contain a valued keyed by the specified String.

addBasedOnValue

public DmcAttribute<?> addBasedOnValue(Object value)
                                throws DmcValueException

Adds another basedOnValue value.

Parameters:

value - A value compatible with String

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getBasedOnValueSize

public int getBasedOnValueSize()

Returns:

the number of values in basedOnValue

delBasedOnValue

public DmcAttribute<?> delBasedOnValue(Object value)
                                throws DmcValueException

Deletes a basedOnValue value.

Parameters:

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

Returns:

the deleted attribute instance

Throws:

DmcValueException - if the value is incorrect

delBasedOnValue

public DmcAttribute<?> delBasedOnValue(String value)

Deletes a basedOnValue from the specified value.

Parameters:

value - String

Returns:

the deleted attribute instance

remBasedOnValue

public void remBasedOnValue()

Removes the basedOnValue attribute value.