RuleDataDMO (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.dmc.DmcObject
- - org.dmd.dms.generated.dmo.RuleDataDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF

Direct Known Subclasses:

AllowedAttributesRuleDataDMO, CardinalityRuleDataDMO, CheckAttributesBasedOnValueRuleDataDMO, InitRuleDataDMO, NamedObjectRuleDataDMO, NumericRangeRuleDataDMO, OneOfTheseAttributesRequiredRuleDataDMO, OnlyOneOfTheseAttributesAllowedRuleDataDMO, PartCheckerRuleDataDMO, PatternMatchRuleDataDMO, ReferencedAttributeTypeRuleDataDMO, RelatedNumbersRuleDataDMO, RestrictReferencesRuleDataDMO, StringSetRuleDataDMO, UCOAllowedAttributesRuleDataDMO, ValueLengthRuleDataDMO
```
public class RuleDataDMO
extends DmcObject
implements DmcNamedObjectIF, Serializable
```
The RuleData class serves as a common base for all ClassDefinitions\n that are generated internally to represent the data associated with RuleDefinitions.

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

RuleDataDMO()

RuleDataDMO(String oc)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DmcAttribute<?>`	`addDescription(Object value)` Adds another description value.
`DmcAttribute<?>`	`addMsgParam(Object value)` Adds another msgParam value.
`ClassDefinitionREF`	`getApplyToClass()` The class to which a rule should be applied.
`SchemaDefinitionREF`	`getDefinedIn()` Indicates the schema in which a type, attribute or class is defined.
`Iterator<String>`	`getDescription()` The description attribute is used to provide descriptive\n documentation for schema related definitions.
`Iterator<String>`	`getDescriptionWithNewlines()`
`String`	`getFile()` Indicates the file from which a definition was loaded.
`Map<Integer,DmcAttributeInfo>`	`getIdToAttrInfo()`
`Boolean`	`getImmediateHalt()` The immediateHalt flag is used to indicate that no further\n rule processing should occur if a rule fails.
`Integer`	`getLineNumber()` Indicates the line number of the file from which a definition was loaded.
`String`	`getMsgKey()` The msgKey may be specified on rule instances to indicate the key to be used\n to look up translated messages.
`Iterator<String>`	`getMsgParam()` The msgParam allows for the specification of parameters to be substituted\n into translated messages.
`RuleDataDMO`	`getNew()` Auto-generated derived classes override this to return an empty instance of themselves.
`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.
`RuleDataDMO`	`getSlice(DmcSliceInfo info)` Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
`Map<String,DmcAttributeInfo>`	`getStringToAttrInfo()`
`void`	`setApplyToClass(Object value)` Sets applyToClass to the specified value.
`void`	`setDefinedIn(Object value)` Sets definedIn to the specified value.
`void`	`setFile(Object value)` Sets file to the specified value.
`void`	`setImmediateHalt(Object value)` Sets immediateHalt to the specified value.
`void`	`setLineNumber(Object value)` Sets lineNumber to the specified value.
`void`	`setMsgKey(Object value)` Sets msgKey to the specified value.
`void`	`setRuleName(Object value)` Sets ruleName to the specified value.
`void`	`setRuleTitle(Object value)` Sets ruleTitle 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.DmcNamedObjectIF
equals

- Constructor Detail
  - RuleDataDMO
```
public RuleDataDMO()
```
  - RuleDataDMO
```
public RuleDataDMO(String oc)
```
- Method Detail
  - getIdToAttrInfo
```
public Map<Integer,DmcAttributeInfo> getIdToAttrInfo()
```
  - getStringToAttrInfo
```
public Map<String,DmcAttributeInfo> getStringToAttrInfo()
```
  - getNew
```
public RuleDataDMO getNew()
```
    Description copied from class: DmcObject
    
    Auto-generated derived classes override this to return an empty instance of themselves. This supports cloning.
    
    Specified by:
    
    getNew in class DmcObject
    
    Returns:
    
    An instance of the derived class.
  - getSlice
```
public RuleDataDMO 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.
    
    Specified by:
    
    getSlice in class DmcObject
    
    Parameters:
    
    info - the slice info
    
    Returns:
    
    An instance of the derived class with the specified slice of attributes.
  - getRuleName
```
public 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. No spaces or \n other characters are allowed.
    
    Returns:
    
    the RuleName
  - setRuleName
```
public void setRuleName(Object value)
                 throws DmcValueException
```
    Sets ruleName to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeRuleNameSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getRuleTitle
```
public String getRuleTitle()
```
    The title of a rule.
    
    Returns:
    
    the String
  - setRuleTitle
```
public void setRuleTitle(Object value)
                  throws DmcValueException
```
    Sets ruleTitle to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getApplyToClass
```
public ClassDefinitionREF getApplyToClass()
```
    The class to which a rule should be applied.
    
    Returns:
    
    the ClassDefinition
  - setApplyToClass
```
public void setApplyToClass(Object value)
                     throws DmcValueException
```
    Sets applyToClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeClassDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDefinedIn
```
public SchemaDefinitionREF getDefinedIn()
```
    Indicates the schema in which a type, attribute or class is defined.
    
    Returns:
    
    the SchemaDefinition
  - setDefinedIn
```
public void setDefinedIn(Object value)
                  throws DmcValueException
```
    Sets definedIn to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeSchemaDefinitionREFSV
    
    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.
    
    Returns:
    
    the String
  - getDescriptionWithNewlines
```
public Iterator<String> getDescriptionWithNewlines()
```
  - addDescription
```
public DmcAttribute<?> addDescription(Object value)
                               throws DmcValueException
```
    Adds another description value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getFile
```
public String getFile()
```
    Indicates the file from which a definition was loaded.
    
    Returns:
    
    the String
  - setFile
```
public void setFile(Object value)
             throws DmcValueException
```
    Sets file to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getImmediateHalt
```
public Boolean getImmediateHalt()
```
    The immediateHalt flag is used to indicate that no further\n rule processing should occur if a rule fails. It is an optional attribute on rule instance\n objects. In somes cases, there is no point in continuing with the application of a set \n of rules, so this flag gives the option of halting further processing.
    
    Returns:
    
    the Boolean
  - setImmediateHalt
```
public void setImmediateHalt(Object value)
                      throws DmcValueException
```
    Sets immediateHalt 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.
    
    Returns:
    
    the Integer
  - setLineNumber
```
public void setLineNumber(Object value)
                   throws DmcValueException
```
    Sets lineNumber to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getMsgKey
```
public String getMsgKey()
```
    The msgKey may be specified on rule instances to indicate the key to be used\n to look up translated messages. This is primarily a GWT mechanism, but should be applicable in\n other contexts.
    
    Returns:
    
    the String
  - setMsgKey
```
public void setMsgKey(Object value)
               throws DmcValueException
```
    Sets msgKey to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getMsgParam
```
public Iterator<String> getMsgParam()
```
    The msgParam allows for the specification of parameters to be substituted\n into translated messages.
    
    Returns:
    
    the String
  - addMsgParam
```
public DmcAttribute<?> addMsgParam(Object value)
                            throws DmcValueException
```
    Adds another msgParam value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObjectName
```
public RuleName getObjectName()
```
    Specified by:
    
    getObjectName in interface DmcNamedObjectIF
    
    Returns:
    
    The name of this object from the ruleName attribute.
  - getObjectNameAttribute
```
public DmcAttribute<?> getObjectNameAttribute()
```
    Specified by:
    
    getObjectNameAttribute in interface DmcNamedObjectIF
    
    Returns:
    
    The ruleName attribute.

Class RuleDataDMO

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

Constructor Detail

RuleDataDMO

RuleDataDMO

Method Detail

getIdToAttrInfo

getStringToAttrInfo

getNew

getSlice

getRuleName

setRuleName

getRuleTitle

setRuleTitle

getApplyToClass

setApplyToClass

getDefinedIn

setDefinedIn

getDescription

getDescriptionWithNewlines

addDescription

getFile

setFile

getImmediateHalt

setImmediateHalt

getLineNumber

setLineNumber

getMsgKey

setMsgKey

getMsgParam

addMsgParam

getObjectName

getObjectNameAttribute