RuleDefinitionDMO (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.dmc.DmcObject
- - org.dmd.dms.generated.dmo.DSDefinitionDMO
  - - org.dmd.dms.generated.dmo.DmsDefinitionDMO
    - - org.dmd.dms.generated.dmo.RuleDefinitionDMO

All Implemented Interfaces:

Serializable, DmcDefinitionIF, DmcNamedObjectIF
```
public class RuleDefinitionDMO
extends DmsDefinitionDMO
implements Serializable, DmcDefinitionIF
```
The RuleDefinition allows for the definition of rules that can\n be applied to attributes or classes. Rules are not just for validation, they\n can be applied to objects at different times in an object's life cycle e.g. \n the InitRule can initialize a set of attributes to known values.\n
\n RuleDefinitions will result in the generation of ClassDefinitions that define the \n DMOs that will carry the parameters associated with the rule and the expectation\n that you will define an implementation class for the rule that derives from\n an abstract BaseImpl (base implementation) of the rule that provides common\n rule infrastructure and appropriate abstract methods that must be filled in.\n
\n RuleDefinitions and ClassDefinitions share the same dmdID space and the IDs must\n be unique. This is because each RuleDefinition results in the creation of a \n ClassDefinition for the DMO part of the rule that carries the rule parameters.

Author:

Auto Generated Generated from: org.dmd.dms.meta.MetaGenerator.dumpDMOClasses(MetaGenerator.java:1957)

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.dmd.dmc.DmcObject
  __objectClass, attributes

Constructor Summary

Constructors
Constructor and Description

RuleDefinitionDMO()

RuleDefinitionDMO(String oc)

Constructors
Constructor and Description
`RuleDefinitionDMO()`
`RuleDefinitionDMO(String oc)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DmcAttribute<?>`	`addComment(Object value)` Adds another comment value.
`DmcAttribute<?>`	`addDescription(Object value)` Adds another description value.
`DmcAttribute<?>`	`addExample(Object value)` Adds another example value.
`DmcAttribute<?>`	`addMay(Object value)` Adds another may value.
`DmcAttribute<?>`	`addMust(Object value)` Adds another must value.
`DmcAttribute<?>`	`addNvp(Object value)` Adds another nvp value.
`DmcAttribute<?>`	`addOptimize(Object value)` Adds another optimize value.
`DmcAttribute<?>`	`addQuestion(Object value)` Adds another question value.
`DmcAttribute<?>`	`addRelatedToConcept(Object value)` Adds another relatedToConcept value.
`DmcAttribute<?>`	`addRuleCategory(Object value)` Adds another ruleCategory value.
`DmcAttribute<?>`	`addSkip(Object value)` Adds another skip value.
`DmcAttribute<?>`	`addTags(Object value)` Adds another tags value.
`Iterator<String>`	`getComment()` A comment or note associated with the definition of something.
`SchemaDefinitionREF`	`getDefinedIn()` Indicates the schema in which a type, attribute or class is defined.
`DependencyREF`	`getDependency()` A reference to a single Dependency.
`Iterator<String>`	`getDescription()` The description attribute is used to provide descriptive\n documentation for schema related definitions.
`Iterator<String>`	`getDescriptionWithNewlines()`
`Integer`	`getDmdID()` The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.
`String`	`getDmoFromModule()` A bit of a hack to allow for creation of fully qualified dot names\n in the DMODefinitionSet that's used for caching definitions in GWT.
`DotName`	`getDotName()` The dotName attribute is used to store dot separated names.
`Iterator<Example>`	`getExample()` The example attribute is used to provide additional\n examples of how some defined thing is to be used.
`String`	`getFile()` Indicates the file from which a definition was loaded.
`String`	`getHint()` A short description of something that can be dumped as one line summary of something.\n For longer explanations, use the description attribute.
`Map<Integer,DmcAttributeInfo>`	`getIdToAttrInfo()`
`Boolean`	`getIsExtensible()` Indicates whether or not the ClassDefinition associated with a RuleDefinition has classType EXTENSIBLE\n or not.
`Integer`	`getLineNumber()` Indicates the line number of the file from which a definition was loaded.
`Iterator<AttributeDefinitionREF>`	`getMay()` Indicates the set of attributes that an instance of a class MAY\n have.
`Iterator<AttributeDefinitionREF>`	`getMust()` Indicates the set of attributes that an instance of a class MUST have.
`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.
`RuleDefinitionDMO`	`getNew()` Auto-generated derived classes override this to return an empty instance of themselves.
`Iterator<NameValuePair>`	`getNvp()` A set of additional name value pairs that can be associated with an object.
`DefinitionName`	`getObjectName()`
`DmcAttribute<?>`	`getObjectNameAttribute()`
`String`	`getObsolete()` The version at which something became obsolete.
`Iterator<String>`	`getOptimize()` Depending on what you're modelling, you often come across\n places where you can see an opportunity to optimize, streamline or improve something e.g.
`Iterator<String>`	`getQuestion()` A question associated with the definition of something.
`Iterator<ConcinnityREF>`	`getRelatedToConcept()` Allows for references to base concepts that relate this\n definition to another definition in the Concinnity domain.
`String`	`getRelationship()` The name of the relationship established via a reference to some other named object.\n
`Iterator<RuleCategoryREF>`	`getRuleCategory()` The category of a rule.
`Boolean`	`getSearchable()` Indicates if something is searchable.
`Iterator<String>`	`getSkip()` A version from which something should be excluded (even though it is included\n in later versions).
`RuleDefinitionDMO`	`getSlice(DmcSliceInfo info)` Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
`DotName`	`getSortName()` The sortName is used in siutations where we need a name\n for storage of a definition that is globally unique but can be sorted on the basis\n of the definition name, not the module name.
`Map<String,DmcAttributeInfo>`	`getStringToAttrInfo()`
`Iterator<String>`	`getTags()` A collection of tags that can facilitate searching for\n definitions.
`String`	`getVersion()` The version at which something was introduced.
`ConcinnityREF`	`getWhy()` An indication of why something was added to a specification or a system.\n This might be a reference to a requirement or feature concept.
`void`	`setDefinedIn(Object value)` Sets definedIn to the specified value.
`void`	`setDependency(Object value)` Sets dependency to the specified value.
`void`	`setDmdID(Object value)` Sets dmdID to the specified value.
`void`	`setDmoFromModule(Object value)` Sets dmoFromModule to the specified value.
`void`	`setDotName(Object value)` Sets dotName to the specified value.
`void`	`setFile(Object value)` Sets file to the specified value.
`void`	`setHint(Object value)` Sets hint to the specified value.
`void`	`setIsExtensible(Object value)` Sets isExtensible to the specified value.
`void`	`setLineNumber(Object value)` Sets lineNumber to the specified value.
`void`	`setName(Object value)` Sets name to the specified value.
`void`	`setObsolete(Object value)` Sets obsolete to the specified value.
`void`	`setRelationship(Object value)` Sets relationship to the specified value.
`void`	`setSearchable(Object value)` Sets searchable to the specified value.
`void`	`setSortName(Object value)` Sets sortName to the specified value.
`void`	`setVersion(Object value)` Sets version to the specified value.
`void`	`setWhy(Object value)` Sets why to the specified value.

Methods inherited from class org.dmd.dmc.DmcObject
add, add, addAux, addAux, addBackref, allowsAttribute, applyModifier, clearReferenceInfo, cloneIt, del, del, delFromEmptyAttribute, deserializeIt, equals, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF
toOIF

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF
equals

- Constructor Detail
  - RuleDefinitionDMO
```
public RuleDefinitionDMO()
```
  - RuleDefinitionDMO
```
public RuleDefinitionDMO(String oc)
```
- Method Detail
  - getIdToAttrInfo
```
public Map<Integer,DmcAttributeInfo> getIdToAttrInfo()
```
    Overrides:
    
    getIdToAttrInfo in class DmsDefinitionDMO
  - getStringToAttrInfo
```
public Map<String,DmcAttributeInfo> getStringToAttrInfo()
```
    Overrides:
    
    getStringToAttrInfo in class DmsDefinitionDMO
  - getNew
```
public RuleDefinitionDMO 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 DmsDefinitionDMO
    
    Returns:
    
    An instance of the derived class.
  - getSlice
```
public RuleDefinitionDMO 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 DmsDefinitionDMO
    
    Parameters:
    
    info - the slice info
    
    Returns:
    
    An instance of the derived class with the specified slice of attributes.
  - getDmdID
```
public Integer getDmdID()
```
    The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.
    
    Returns:
    
    the Integer
  - setDmdID
```
public void setDmdID(Object value)
              throws DmcValueException
```
    Sets dmdID to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - 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 DmsDefinitionDMO
    
    Returns:
    
    the DefinitionName
  - setName
```
public void setName(Object value)
             throws DmcValueException
```
    Sets name to the specified value.
    
    Overrides:
    
    setName in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeDefinitionNameSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getRuleCategory
```
public Iterator<RuleCategoryREF> getRuleCategory()
```
    The category of a rule.
    
    Returns:
    
    the RuleCategory
  - addRuleCategory
```
public DmcAttribute<?> addRuleCategory(Object value)
                                throws DmcValueException
```
    Adds another ruleCategory value.
    
    Parameters:
    
    value - A value compatible with DmcTypeRuleCategoryREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getComment
```
public Iterator<String> getComment()
```
    A comment or note associated with the definition of something. For\n code that's generated from a definition, comments may be added to the code, as opposed to \n descriptions which are meant to assist in generating documentation. In the end, it's up to\n the designer of a DSL to determine how comments are used.
    
    Overrides:
    
    getComment in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addComment
```
public DmcAttribute<?> addComment(Object value)
                           throws DmcValueException
```
    Adds another comment value.
    
    Overrides:
    
    addComment in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDefinedIn
```
public SchemaDefinitionREF getDefinedIn()
```
    Indicates the schema in which a type, attribute or class is defined.
    
    Specified by:
    
    getDefinedIn in interface DmcDefinitionIF
    
    Overrides:
    
    getDefinedIn in class DmsDefinitionDMO
    
    Returns:
    
    the SchemaDefinition
  - setDefinedIn
```
public void setDefinedIn(Object value)
                  throws DmcValueException
```
    Sets definedIn to the specified value.
    
    Overrides:
    
    setDefinedIn in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeSchemaDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDependency
```
public DependencyREF getDependency()
```
    A reference to a single Dependency.
    
    Returns:
    
    the Dependency
  - setDependency
```
public void setDependency(Object value)
                   throws DmcValueException
```
    Sets dependency to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDependencyREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDescription
```
public Iterator<String> getDescription()
```
    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 DmsDefinitionDMO
    
    Returns:
    
    the String
  - getDescriptionWithNewlines
```
public Iterator<String> getDescriptionWithNewlines()
```
    Overrides:
    
    getDescriptionWithNewlines in class DmsDefinitionDMO
  - addDescription
```
public DmcAttribute<?> addDescription(Object value)
                               throws DmcValueException
```
    Adds another description value.
    
    Overrides:
    
    addDescription in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmoFromModule
```
public String getDmoFromModule()
```
    A bit of a hack to allow for creation of fully qualified dot names\n in the DMODefinitionSet that's used for caching definitions in GWT. On the DMW side, this\n is taken care of by overloading the getNameOfModuleWhereThisCameFrom() to access the \n getDefinedInModule attribute and getting the name of the module.
    
    Overrides:
    
    getDmoFromModule in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setDmoFromModule
```
public void setDmoFromModule(Object value)
                      throws DmcValueException
```
    Sets dmoFromModule to the specified value.
    
    Overrides:
    
    setDmoFromModule in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDotName
```
public DotName getDotName()
```
    The dotName attribute is used to store dot separated names.
    
    Specified by:
    
    getDotName in interface DmcDefinitionIF
    
    Overrides:
    
    getDotName in class DmsDefinitionDMO
    
    Returns:
    
    the DotName
  - setDotName
```
public void setDotName(Object value)
                throws DmcValueException
```
    Sets dotName to the specified value.
    
    Overrides:
    
    setDotName in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeDotNameSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getExample
```
public Iterator<Example> getExample()
```
    The example attribute is used to provide additional\n examples of how some defined thing is to be used.
    
    Overrides:
    
    getExample in class DmsDefinitionDMO
    
    Returns:
    
    the Example
  - addExample
```
public DmcAttribute<?> addExample(Object value)
                           throws DmcValueException
```
    Adds another example value.
    
    Overrides:
    
    addExample in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeExampleMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getFile
```
public String getFile()
```
    Indicates the file from which a definition was loaded.
    
    Overrides:
    
    getFile in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setFile
```
public void setFile(Object value)
             throws DmcValueException
```
    Sets file to the specified value.
    
    Overrides:
    
    setFile in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getHint
```
public String getHint()
```
    A short description of something that can be dumped as one line summary of something.\n For longer explanations, use the description attribute.
    
    Overrides:
    
    getHint in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setHint
```
public void setHint(Object value)
             throws DmcValueException
```
    Sets hint to the specified value.
    
    Overrides:
    
    setHint in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIsExtensible
```
public Boolean getIsExtensible()
```
    Indicates whether or not the ClassDefinition associated with a RuleDefinition has classType EXTENSIBLE\n or not. This mechanism is useful in situations where the exact set of attributes associated with a rule must be flexible.\n The best example is the InitRule where any set of attributes can be specified as value for the rule.
    
    Returns:
    
    the Boolean
  - setIsExtensible
```
public void setIsExtensible(Object value)
                     throws DmcValueException
```
    Sets isExtensible to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getLineNumber
```
public Integer getLineNumber()
```
    Indicates the line number of the file from which a definition was loaded.
    
    Overrides:
    
    getLineNumber in class DmsDefinitionDMO
    
    Returns:
    
    the Integer
  - setLineNumber
```
public void setLineNumber(Object value)
                   throws DmcValueException
```
    Sets lineNumber to the specified value.
    
    Overrides:
    
    setLineNumber in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getMay
```
public Iterator<AttributeDefinitionREF> getMay()
```
    Indicates the set of attributes that an instance of a class MAY\n have. When accessed in Java, this is a set of references to AttributeDefinition\n objects.
    
    Returns:
    
    the AttributeDefinition
  - addMay
```
public DmcAttribute<?> addMay(Object value)
                       throws DmcValueException
```
    Adds another may value.
    
    Parameters:
    
    value - A value compatible with DmcTypeAttributeDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getMust
```
public Iterator<AttributeDefinitionREF> getMust()
```
    Indicates the set of attributes that an instance of a class MUST have.
    
    Returns:
    
    the AttributeDefinition
  - addMust
```
public DmcAttribute<?> addMust(Object value)
                        throws DmcValueException
```
    Adds another must value.
    
    Parameters:
    
    value - A value compatible with DmcTypeAttributeDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getNvp
```
public Iterator<NameValuePair> getNvp()
```
    A set of additional name value pairs that can be associated with an object.
    
    Overrides:
    
    getNvp in class DmsDefinitionDMO
    
    Returns:
    
    the NameValuePair
  - addNvp
```
public DmcAttribute<?> addNvp(Object value)
                       throws DmcValueException
```
    Adds another nvp value.
    
    Overrides:
    
    addNvp in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeNameValuePairMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObsolete
```
public String getObsolete()
```
    The version at which something became obsolete.
    
    Overrides:
    
    getObsolete in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setObsolete
```
public void setObsolete(Object value)
                 throws DmcValueException
```
    Sets obsolete to the specified value.
    
    Overrides:
    
    setObsolete in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getOptimize
```
public Iterator<String> getOptimize()
```
    Depending on what you're modelling, you often come across\n places where you can see an opportunity to optimize, streamline or improve something e.g. merging\n concepts together, representing something differently, adding a relationship - whatever.\n However, these ideas often get lost in the shuffle or, if you add them into an overall\n description of something, they don't stand out.\n
    \n Any dark-matter definition can be decorated with optimize notes. These notes provide
    
    Overrides:
    
    getOptimize in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addOptimize
```
public DmcAttribute<?> addOptimize(Object value)
                            throws DmcValueException
```
    Adds another optimize value.
    
    Overrides:
    
    addOptimize in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getQuestion
```
public Iterator<String> getQuestion()
```
    A question associated with the definition of something.
    
    Overrides:
    
    getQuestion in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addQuestion
```
public DmcAttribute<?> addQuestion(Object value)
                            throws DmcValueException
```
    Adds another question value.
    
    Overrides:
    
    addQuestion in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getRelatedToConcept
```
public Iterator<ConcinnityREF> getRelatedToConcept()
```
    Allows for references to base concepts that relate this\n definition to another definition in the Concinnity domain. This mechanism is only used\n in the domain of dark-matter schema definitions; other DSLs will allow for direct\n reference to Concinnity concepts.
    
    Overrides:
    
    getRelatedToConcept in class DmsDefinitionDMO
    
    Returns:
    
    the Concinnity
  - addRelatedToConcept
```
public DmcAttribute<?> addRelatedToConcept(Object value)
                                    throws DmcValueException
```
    Adds another relatedToConcept value.
    
    Overrides:
    
    addRelatedToConcept in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeConcinnityREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getRelationship
```
public String getRelationship()
```
    The name of the relationship established via a reference to some other named object.\n
    \n This is a minor hack to allow creation of named relationships in graph databases. Eventually, relationships\n will become first class objects to which you can refer.
    
    Overrides:
    
    getRelationship in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setRelationship
```
public void setRelationship(Object value)
                     throws DmcValueException
```
    Sets relationship to the specified value.
    
    Overrides:
    
    setRelationship in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSearchable
```
public Boolean getSearchable()
```
    Indicates if something is searchable.
    
    Overrides:
    
    getSearchable in class DmsDefinitionDMO
    
    Returns:
    
    the Boolean
  - setSearchable
```
public void setSearchable(Object value)
                   throws DmcValueException
```
    Sets searchable to the specified value.
    
    Overrides:
    
    setSearchable in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSkip
```
public Iterator<String> getSkip()
```
    A version from which something should be excluded (even though it is included\n in later versions). This is an unusual situation, and should be approached with extreme caution!
    
    Overrides:
    
    getSkip in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addSkip
```
public DmcAttribute<?> addSkip(Object value)
                        throws DmcValueException
```
    Adds another skip value.
    
    Overrides:
    
    addSkip in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSortName
```
public DotName getSortName()
```
    The sortName is used in siutations where we need a name\n for storage of a definition that is globally unique but can be sorted on the basis\n of the definition name, not the module name. The dotName for a definition is\n module.definition...type, whereas the sortName would be definition...module.type.\n So, for things like documentation generation, the sortName provides a more \n natural ordering.
    
    Overrides:
    
    getSortName in class DmsDefinitionDMO
    
    Returns:
    
    the DotName
  - setSortName
```
public void setSortName(Object value)
                 throws DmcValueException
```
    Sets sortName to the specified value.
    
    Overrides:
    
    setSortName in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeDotNameSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getTags
```
public Iterator<String> getTags()
```
    A collection of tags that can facilitate searching for\n definitions. The values are limited to a-zA-Z0-9 and the space character.
    
    Overrides:
    
    getTags in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addTags
```
public DmcAttribute<?> addTags(Object value)
                        throws DmcValueException
```
    Adds another tags value.
    
    Overrides:
    
    addTags in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getVersion
```
public String getVersion()
```
    The version at which something was introduced. Version names\n are assumed to be lexicographically sortable i.e. the name of a version must have a nautral\n sort order that increases.
    
    Overrides:
    
    getVersion in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setVersion
```
public void setVersion(Object value)
                throws DmcValueException
```
    Sets version to the specified value.
    
    Overrides:
    
    setVersion in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getWhy
```
public ConcinnityREF getWhy()
```
    An indication of why something was added to a specification or a system.\n This might be a reference to a requirement or feature concept. How this is used will depend on context.\n Due to the fact that it is a weak reference, you may also just put in free form text, since it\n will simply be treated as an unresolved reference.
    
    Overrides:
    
    getWhy in class DmsDefinitionDMO
    
    Returns:
    
    the Concinnity
  - setWhy
```
public void setWhy(Object value)
            throws DmcValueException
```
    Sets why to the specified value.
    
    Overrides:
    
    setWhy in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeConcinnityREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObjectName
```
public DefinitionName getObjectName()
```
    Specified by:
    
    getObjectName in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectName in class DmsDefinitionDMO
    
    Returns:
    
    The name of this object from the name attribute.
  - getObjectNameAttribute
```
public DmcAttribute<?> getObjectNameAttribute()
```
    Specified by:
    
    getObjectNameAttribute in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectNameAttribute in class DmsDefinitionDMO
    
    Returns:
    
    The name attribute.

Class RuleDefinitionDMO

Field Summary

Fields inherited from class org.dmd.dmc.DmcObject

Constructor Summary

Method Summary

Methods inherited from class org.dmd.dmc.DmcObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

Constructor Detail

RuleDefinitionDMO

RuleDefinitionDMO

Method Detail

getIdToAttrInfo

getStringToAttrInfo

getNew

getSlice

getDmdID

setDmdID

getName

setName

getRuleCategory

addRuleCategory

getComment

addComment

getDefinedIn

setDefinedIn

getDependency

setDependency

getDescription

getDescriptionWithNewlines

addDescription

getDmoFromModule

setDmoFromModule

getDotName

setDotName

getExample

addExample

getFile

setFile

getHint

setHint

getIsExtensible

setIsExtensible

getLineNumber

setLineNumber

getMay

addMay

getMust

addMust

getNvp

addNvp

getObsolete

setObsolete

getOptimize

addOptimize

getQuestion

addQuestion

getRelatedToConcept

addRelatedToConcept

getRelationship

setRelationship

getSearchable

setSearchable

getSkip

addSkip

getSortName

setSortName

getTags

addTags

getVersion

setVersion

getWhy

setWhy

getObjectName

getObjectNameAttribute