ICMMNRequiredRule

All Superinterfaces:

IModelElement, IModelElementParent, INoChildrenBaseModelElement
```
public interface ICMMNRequiredRule
extends INoChildrenBaseModelElement
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_ANALYSIS_ITEM_DIAGRAM_IDS`
`static java.lang.String`	`PROP_ANALYSIS_ITEM_MODELS`
`static java.lang.String`	`PROP_CONDITION`
`static java.lang.String`	`PROP_CONTEXT`
`static java.lang.String`	`PROP_QUALITY_REASON`
`static java.lang.String`	`PROP_QUALITY_SCORE`
`static java.lang.String`	`PROP_STEREOTYPES`
`static java.lang.String`	`PROP_SYNC_MAPPING_MODELS`
`static java.lang.String`	`PROP_TAGGED_VALUES`

Fields inherited from interface com.vp.plugin.model.IModelElement
MODEL_QUALITY_SCORE_IGNORE, MODEL_QUALITY_SCORE_RECALCULATE, PROP_NAME

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAnalysisItemModel(IModelElement analysisItemModel)`
`void`	`addStereotype(IStereotype stereotype)` Add a stereotype `IStereotype` into this model element.
`void`	`addStereotype(java.lang.String name)` Add a stereotype into this model element.
`void`	`addStereotypes(java.lang.String name)` Deprecated. Replaced by addStereotype
`void`	`addSyncMappingModel(IModelElement syncMappingModel)`
`int`	`analysisItemModelCount()`
`java.util.Iterator`	`analysisItemModelIterator()` Returns an iterator over the model elements `IModelElement`.
`int`	`fromRelationshipCount()` Number of `ISimpleRelationship` that connect from this model element.
`int`	`fromRelationshipEndCount()` Number of `IRelationshipEnd` that connect from this model element.
`java.util.Iterator`	`fromRelationshipEndIterator()` `IRelationshipEnd`s that connect from this model element.
`java.util.Iterator`	`fromRelationshipIterator()` `ISimpleRelationship`s that connect from this model element.
`java.lang.String[]`	`getAnalysisItemDiagramIds()`
`IModelElement`	`getAnalysisItemModelByIndex(int index)`
`java.lang.String`	`getCondition()`
`ICMMNCaseFileItem`	`getContext()`
`java.lang.String`	`getQualityReason()` Quality reason, it is non-readable value for human
`int`	`getQualityScore()` Quality score, it is non-readable value for human
`IModelElement`	`getSyncMappingModelByIndex(int index)`
`ITaggedValueContainer`	`getTaggedValues()`
`boolean`	`hasStereotype(java.lang.String name)`
`boolean`	`hasStereotypes(java.lang.String name)` Deprecated. Replaced by hasStereotype
`void`	`removeAnalysisItemModel(IModelElement analysisItemModel)`
`void`	`removeAnalysisItemModelByIndex(int index)`
`void`	`removeStereotype(IStereotype stereotype)` Remove a stereotype `IStereotype` from this model element.
`void`	`removeStereotype(java.lang.String name)` Remove a stereotype from this model element.
`void`	`removeStereotypes(java.lang.String name)` Deprecated. Replaced by removeStereotype
`void`	`removeSyncMappingModel(IModelElement syncMappingModel)`
`void`	`removeSyncMappingModelByIndex(int index)`
`void`	`setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)`
`void`	`setCondition(java.lang.String condition)`
`void`	`setContext(ICMMNCaseFileItem context)`
`void`	`setQualityReason(java.lang.String qualityReason)`
`void`	`setQualityScore(int qualityScore)`
`void`	`setTaggedValues(ITaggedValueContainer taggedValues)`
`int`	`stereotypeCount()`
`java.util.Iterator`	`stereotypeIterator()` Returns an iterator over the names of the stereotypes.
`java.util.Iterator`	`stereotypeModelIterator()` Returns an iterator over the model elements `IStereotype`.
`int`	`stereotypesCount()` Deprecated. Replaced by stereotypeCount
`java.util.Iterator`	`stereotypesIterator()` Deprecated. Replaced by stereotypeIterator
`java.util.Iterator`	`stereotypesModelIterator()` Deprecated. Replaced by stereotypeModelIterator
`int`	`syncMappingModelCount()`
`java.util.Iterator`	`syncMappingModelIterator()` Returns an iterator over the model elements `IModelElement`.
`IModelElement[]`	`toAnalysisItemModelArray()`
`ISimpleRelationship[]`	`toFromRelationshipArray()` `ISimpleRelationship`s that connect from this model element.
`IRelationshipEnd[]`	`toFromRelationshipEndArray()` `IRelationshipEnd`s that connect from this model element.
`int`	`toRelationshipCount()` Number of `ISimpleRelationship` that connect to this model element.
`int`	`toRelationshipEndCount()` Number of `IRelationshipEnd` that connect to this model element.
`java.util.Iterator`	`toRelationshipEndIterator()` `IRelationshipEnd`s that connect to this model element.
`java.util.Iterator`	`toRelationshipIterator()` `ISimpleRelationship`s that connect to this model element.
`java.lang.String[]`	`toStereotypeArray()`
`IStereotype[]`	`toStereotypeModelArray()`
`java.lang.String[]`	`toStereotypesArray()` Deprecated. Replaced by toStereotypeArray
`IStereotype[]`	`toStereotypesModelArray()` Deprecated. Replaced by toStereotypeModelArray
`IModelElement[]`	`toSyncMappingModelArray()`
`ISimpleRelationship[]`	`toToRelationshipArray()` `ISimpleRelationship`s that connect to this model element.
`IRelationshipEnd[]`	`toToRelationshipEndArray()` `IRelationshipEnd`s that connect to this model element.

Methods inherited from interface com.vp.plugin.model.INoChildrenBaseModelElement
addComment, addGenericValue, addReference, addVoice, commentCount, commentIterator, genericValueCount, genericValueIterator, getBacklogActivityId, getCommentByIndex, getDescription, getGenericValueByIndex, getHTMLDescription, getHTMLDescription, getPmAuthor, getPmCreateDateTime, getPmDifficulty, getPmDiscipline, getPmIteration, getPmLastModified, getPmPhase, getPmPriority, getPmStatus, getPmVersion, getReferenceByIndex, getReferencedByDiagramIds, getReferencedByModelAddresses, getTransitFrom, getTransitTo, getUserID, getUserIDLastNumericValue, getUserIDParent, getVoiceByIndex, referenceCount, referenceIterator, removeComment, removeCommentByIndex, removeGenericValue, removeGenericValueByIndex, removeReference, removeReferenceByIndex, removeVoice, removeVoiceByIndex, setBacklogActivityId, setDescription, setHTMLDescription, setPmAuthor, setPmCreateDateTime, setPmDifficulty, setPmDiscipline, setPmIteration, setPmLastModified, setPmPhase, setPmPriority, setPmStatus, setPmVersion, setReferencedByDiagramIds, setReferencedByModelAddresses, setTransitFrom, setTransitTo, setUserID, setUserIDLastNumericValue, setUserIDParent, toCommentArray, toGenericValueArray, toReferenceArray, toVoiceArray, voiceCount, voiceIterator

Methods inherited from interface com.vp.plugin.model.IModelElement
addChild, addPropertyChangeListener, addSubDiagram, canModify, childCount, childCount, childCount, childIterator, childIterator, childIterator, constraintsIterator, createChild, delete, disposeTransientModel, duplicate, fromChartRelationshipCount, fromChartRelationshipIterator, getAddress, getChildById, getChildByIndex, getChildByIndex, getChildByName, getChildByName, getDescriptionWithReferenceModels, getDiagramElements, getDisplayQualityScore, getDocumentation, getDocumentationWithReferenceModels, getHTMLDescriptionWithReferenceModels, getHTMLDescriptionWithReferenceModels, getHTMLDocumentation, getHTMLDocumentation, getHTMLDocumentationWithReferenceModels, getHTMLDocumentationWithReferenceModels, getId, getMasterView, getMirrorSource, getModelPropertyByName, getModelQualityDetails, getModelType, getName, getNickDescription, getNickDescriptionWithReferenceModels, getNickDocumentation, getNickDocumentationWithReferenceModels, getNickHTMLDescription, getNickHTMLDescription, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDocumentation, getNickHTMLDocumentation, getNickHTMLDocumentationWithReferenceModels, getNickHTMLDocumentationWithReferenceModels, getNickname, getNickPropertyValue, getParent, getProject, getReferencedBys, getReferencingModels, getSubDiagramAt, indexOfSubDiagram, isMirrorModelElement, isTransientModel, removeChild, removeChildByIndex, removePropertyChangeListener, removeSubDiagram, setDocumentation, setHTMLDocumentation, setName, setNickDescription, setNickDocumentation, setNickHTMLDescription, setNickHTMLDocumentation, setNickname, subDiagramCount, subDiagramIterator, toChartRelationshipCount, toChartRelationshipIterator, toChildArray, toChildArray, toChildArray, toFromChartRelationshipArray, toModelPropertyArray, toPropertiesString, toSubDiagramArray, toToChartRelationshipArray

- Field Detail
  - PROP_STEREOTYPES
```
static final java.lang.String PROP_STEREOTYPES
```
    See Also:
    
    Constant Field Values
  - PROP_TAGGED_VALUES
```
static final java.lang.String PROP_TAGGED_VALUES
```
    See Also:
    
    Constant Field Values
  - PROP_SYNC_MAPPING_MODELS
```
static final java.lang.String PROP_SYNC_MAPPING_MODELS
```
    See Also:
    
    Constant Field Values
  - PROP_ANALYSIS_ITEM_MODELS
```
static final java.lang.String PROP_ANALYSIS_ITEM_MODELS
```
    See Also:
    
    Constant Field Values
  - PROP_ANALYSIS_ITEM_DIAGRAM_IDS
```
static final java.lang.String PROP_ANALYSIS_ITEM_DIAGRAM_IDS
```
    See Also:
    
    Constant Field Values
  - PROP_QUALITY_SCORE
```
static final java.lang.String PROP_QUALITY_SCORE
```
    See Also:
    
    Constant Field Values
  - PROP_QUALITY_REASON
```
static final java.lang.String PROP_QUALITY_REASON
```
    See Also:
    
    Constant Field Values
  - PROP_CONTEXT
```
static final java.lang.String PROP_CONTEXT
```
    See Also:
    
    Constant Field Values
  - PROP_CONDITION
```
static final java.lang.String PROP_CONDITION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - fromRelationshipCount
```
int fromRelationshipCount()
```
    Number of ISimpleRelationship that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipCount in interface IModelElement
    
    Returns:
    
    Number of FROM simple relationships
  - toFromRelationshipArray
```
ISimpleRelationship[] toFromRelationshipArray()
```
    ISimpleRelationships that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toFromRelationshipArray in interface IModelElement
    
    Returns:
    
    ISimpleRelationships that connect from this model element
  - fromRelationshipIterator
```
java.util.Iterator fromRelationshipIterator()
```
    ISimpleRelationships that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipIterator in interface IModelElement
    
    Returns:
    
    ISimpleRelationships that connect from this model element
  - toRelationshipCount
```
int toRelationshipCount()
```
    Number of ISimpleRelationship that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipCount in interface IModelElement
    
    Returns:
    
    Number of TO simple relationships
  - toToRelationshipArray
```
ISimpleRelationship[] toToRelationshipArray()
```
    ISimpleRelationships that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toToRelationshipArray in interface IModelElement
    
    Returns:
    
    ISimpleRelationships that connect to this model element
  - toRelationshipIterator
```
java.util.Iterator toRelationshipIterator()
```
    ISimpleRelationships that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipIterator in interface IModelElement
    
    Returns:
    
    ISimpleRelationships that connect to this model element
  - fromRelationshipEndCount
```
int fromRelationshipEndCount()
```
    Number of IRelationshipEnd that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipEndCount in interface IModelElement
    
    Returns:
    
    Number of FROM relationship ends
  - toFromRelationshipEndArray
```
IRelationshipEnd[] toFromRelationshipEndArray()
```
    IRelationshipEnds that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toFromRelationshipEndArray in interface IModelElement
    
    Returns:
    
    IRelationshipEnds that connect from this model element
  - fromRelationshipEndIterator
```
java.util.Iterator fromRelationshipEndIterator()
```
    IRelationshipEnds that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipEndIterator in interface IModelElement
    
    Returns:
    
    IRelationshipEnds that connect from this model element
  - toRelationshipEndCount
```
int toRelationshipEndCount()
```
    Number of IRelationshipEnd that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipEndCount in interface IModelElement
    
    Returns:
    
    Number of TO relationship ends
  - toToRelationshipEndArray
```
IRelationshipEnd[] toToRelationshipEndArray()
```
    IRelationshipEnds that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toToRelationshipEndArray in interface IModelElement
    
    Returns:
    
    IRelationshipEnds that connect to this model element
  - toRelationshipEndIterator
```
java.util.Iterator toRelationshipEndIterator()
```
    IRelationshipEnds that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipEndIterator in interface IModelElement
    
    Returns:
    
    IRelationshipEnds that connect to this model element
  - addStereotype
```
void addStereotype(java.lang.String name)
```
    Description copied from interface: IModelElement
    
    Add a stereotype into this model element. If the IStereotype does not existing in current project. It will be auto created.
    
    Specified by:
    
    addStereotype in interface IModelElement
  - removeStereotype
```
void removeStereotype(java.lang.String name)
```
    Description copied from interface: IModelElement
    
    Remove a stereotype from this model element.
    
    Specified by:
    
    removeStereotype in interface IModelElement
  - addStereotype
```
void addStereotype(IStereotype stereotype)
```
    Add a stereotype IStereotype into this model element. The IStereotype may belong to current project or referenced project(s). Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2378
    
    Specified by:
    
    addStereotype in interface IModelElement
    
    Parameters:
    
    stereotype - the IStereotype will be added into this model element.
    The baseType of the IStereotype is required to be matched with modelType of this model element. If they are different, or stereotype is null, will cause an IllegalArgumentException.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the stereotype is null, or its baseType does not match with modelType of this model element.
  - removeStereotype
```
void removeStereotype(IStereotype stereotype)
```
    Remove a stereotype IStereotype from this model element. The IStereotype can belong to current project or referenced project(s).
    
    Specified by:
    
    removeStereotype in interface IModelElement
    
    Parameters:
    
    stereotype - the IStereotype will be removed from this model element.
  - hasStereotype
```
boolean hasStereotype(java.lang.String name)
```
    Specified by:
    
    hasStereotype in interface IModelElement
  - stereotypeCount
```
int stereotypeCount()
```
    Specified by:
    
    stereotypeCount in interface IModelElement
  - toStereotypeArray
```
java.lang.String[] toStereotypeArray()
```
  - stereotypeIterator
```
java.util.Iterator stereotypeIterator()
```
    Returns an iterator over the names of the stereotypes.
  - stereotypeModelIterator
```
java.util.Iterator stereotypeModelIterator()
```
    Returns an iterator over the model elements IStereotype.
    
    Specified by:
    
    stereotypeModelIterator in interface IModelElement
  - toStereotypeModelArray
```
IStereotype[] toStereotypeModelArray()
```
    Specified by:
    
    toStereotypeModelArray in interface IModelElement
  - addStereotypes
```
void addStereotypes(java.lang.String name)
```
    Deprecated. Replaced by addStereotype
  - removeStereotypes
```
void removeStereotypes(java.lang.String name)
```
    Deprecated. Replaced by removeStereotype
  - hasStereotypes
```
boolean hasStereotypes(java.lang.String name)
```
    Deprecated. Replaced by hasStereotype
  - stereotypesCount
```
int stereotypesCount()
```
    Deprecated. Replaced by stereotypeCount
  - toStereotypesArray
```
java.lang.String[] toStereotypesArray()
```
    Deprecated. Replaced by toStereotypeArray
  - stereotypesIterator
```
java.util.Iterator stereotypesIterator()
```
    Deprecated. Replaced by stereotypeIterator
  - stereotypesModelIterator
```
java.util.Iterator stereotypesModelIterator()
```
    Deprecated. Replaced by stereotypeModelIterator
  - toStereotypesModelArray
```
IStereotype[] toStereotypesModelArray()
```
    Deprecated. Replaced by toStereotypeModelArray
  - setTaggedValues
```
void setTaggedValues(ITaggedValueContainer taggedValues)
```
    Specified by:
    
    setTaggedValues in interface IModelElement
  - getTaggedValues
```
ITaggedValueContainer getTaggedValues()
```
    Specified by:
    
    getTaggedValues in interface IModelElement
  - addSyncMappingModel
```
void addSyncMappingModel(IModelElement syncMappingModel)
```
  - removeSyncMappingModel
```
void removeSyncMappingModel(IModelElement syncMappingModel)
```
  - getSyncMappingModelByIndex
```
IModelElement getSyncMappingModelByIndex(int index)
```
  - removeSyncMappingModelByIndex
```
void removeSyncMappingModelByIndex(int index)
```
  - syncMappingModelCount
```
int syncMappingModelCount()
```
  - syncMappingModelIterator
```
java.util.Iterator syncMappingModelIterator()
```
    Returns an iterator over the model elements IModelElement.
  - toSyncMappingModelArray
```
IModelElement[] toSyncMappingModelArray()
```
  - addAnalysisItemModel
```
void addAnalysisItemModel(IModelElement analysisItemModel)
```
  - removeAnalysisItemModel
```
void removeAnalysisItemModel(IModelElement analysisItemModel)
```
  - getAnalysisItemModelByIndex
```
IModelElement getAnalysisItemModelByIndex(int index)
```
  - removeAnalysisItemModelByIndex
```
void removeAnalysisItemModelByIndex(int index)
```
  - analysisItemModelCount
```
int analysisItemModelCount()
```
  - analysisItemModelIterator
```
java.util.Iterator analysisItemModelIterator()
```
    Returns an iterator over the model elements IModelElement.
  - toAnalysisItemModelArray
```
IModelElement[] toAnalysisItemModelArray()
```
  - setAnalysisItemDiagramIds
```
void setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)
```
  - getAnalysisItemDiagramIds
```
java.lang.String[] getAnalysisItemDiagramIds()
```
  - setQualityScore
```
void setQualityScore(int qualityScore)
```
  - getQualityScore
```
int getQualityScore()
```
    Description copied from interface: IModelElement
    
    Quality score, it is non-readable value for human
    
    Specified by:
    
    getQualityScore in interface IModelElement
  - setQualityReason
```
void setQualityReason(java.lang.String qualityReason)
```
  - getQualityReason
```
java.lang.String getQualityReason()
```
    Description copied from interface: IModelElement
    
    Quality reason, it is non-readable value for human
    
    Specified by:
    
    getQualityReason in interface IModelElement
  - setContext
```
void setContext(ICMMNCaseFileItem context)
```
  - getContext
```
ICMMNCaseFileItem getContext()
```
  - setCondition
```
void setCondition(java.lang.String condition)
```
  - getCondition
```
java.lang.String getCondition()
```

Interface ICMMNRequiredRule

Field Summary

Fields inherited from interface com.vp.plugin.model.INoChildrenBaseModelElement

Fields inherited from interface com.vp.plugin.model.IModelElement

Method Summary

Methods inherited from interface com.vp.plugin.model.INoChildrenBaseModelElement

Methods inherited from interface com.vp.plugin.model.IModelElement

Field Detail

PROP_STEREOTYPES

PROP_TAGGED_VALUES

PROP_SYNC_MAPPING_MODELS

PROP_ANALYSIS_ITEM_MODELS

PROP_ANALYSIS_ITEM_DIAGRAM_IDS

PROP_QUALITY_SCORE

PROP_QUALITY_REASON

PROP_CONTEXT

PROP_CONDITION

Method Detail

fromRelationshipCount

toFromRelationshipArray

fromRelationshipIterator

toRelationshipCount

toToRelationshipArray

toRelationshipIterator

fromRelationshipEndCount

toFromRelationshipEndArray

fromRelationshipEndIterator

toRelationshipEndCount

toToRelationshipEndArray

toRelationshipEndIterator

addStereotype

removeStereotype

addStereotype

removeStereotype

hasStereotype

stereotypeCount

toStereotypeArray

stereotypeIterator

stereotypeModelIterator

toStereotypeModelArray

addStereotypes

removeStereotypes

hasStereotypes

stereotypesCount

toStereotypesArray

stereotypesIterator

stereotypesModelIterator

toStereotypesModelArray

setTaggedValues

getTaggedValues

addSyncMappingModel

removeSyncMappingModel

getSyncMappingModelByIndex

removeSyncMappingModelByIndex

syncMappingModelCount

syncMappingModelIterator

toSyncMappingModelArray

addAnalysisItemModel

removeAnalysisItemModel

getAnalysisItemModelByIndex

removeAnalysisItemModelByIndex

analysisItemModelCount

analysisItemModelIterator

toAnalysisItemModelArray

setAnalysisItemDiagramIds

getAnalysisItemDiagramIds

setQualityScore

getQualityScore

setQualityReason

getQualityReason

setContext

getContext

setCondition

getCondition