IBPCorrelationKey

All Superinterfaces:

IModelElement, IModelElementParent, INoChildrenNoRelationshipBaseModelElement
```
public interface IBPCorrelationKey
extends INoChildrenNoRelationshipBaseModelElement
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_CORRELATION_PROPERTIES`
`static java.lang.String`	`PROP_QUALITY_REASON`
`static java.lang.String`	`PROP_QUALITY_SCORE`

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
Modifier and Type	Method and Description
`void`	`addCorrelationProperty(IBPCorrelationProperty correlationProperty)`
`int`	`correlationPropertyCount()`
`java.util.Iterator`	`correlationPropertyIterator()` Returns an iterator over the model elements `IBPCorrelationProperty`.
`IBPCorrelationProperty`	`getCorrelationPropertyByIndex(int index)`
`java.lang.String`	`getQualityReason()` Quality reason, it is non-readable value for human
`int`	`getQualityScore()` Quality score, it is non-readable value for human
`void`	`removeCorrelationProperty(IBPCorrelationProperty correlationProperty)`
`void`	`removeCorrelationPropertyByIndex(int index)`
`void`	`setQualityReason(java.lang.String qualityReason)`
`void`	`setQualityScore(int qualityScore)`
`IBPCorrelationProperty[]`	`toCorrelationPropertyArray()`

Methods inherited from interface com.vp.plugin.model.INoChildrenNoRelationshipBaseModelElement
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, addStereotype, addStereotype, addSubDiagram, canModify, childCount, childCount, childCount, childIterator, childIterator, childIterator, constraintsIterator, createChild, delete, disposeTransientModel, duplicate, fromChartRelationshipCount, fromChartRelationshipIterator, fromRelationshipCount, fromRelationshipEndCount, fromRelationshipEndIterator, fromRelationshipIterator, 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, getTaggedValues, hasStereotype, indexOfSubDiagram, isMirrorModelElement, isTransientModel, removeChild, removeChildByIndex, removePropertyChangeListener, removeStereotype, removeStereotype, removeSubDiagram, setDocumentation, setHTMLDocumentation, setName, setNickDescription, setNickDocumentation, setNickHTMLDescription, setNickHTMLDocumentation, setNickname, setTaggedValues, stereotypeCount, stereotypeModelIterator, subDiagramCount, subDiagramIterator, toChartRelationshipCount, toChartRelationshipIterator, toChildArray, toChildArray, toChildArray, toFromChartRelationshipArray, toFromRelationshipArray, toFromRelationshipEndArray, toModelPropertyArray, toPropertiesString, toRelationshipCount, toRelationshipEndCount, toRelationshipEndIterator, toRelationshipIterator, toStereotypeModelArray, toSubDiagramArray, toToChartRelationshipArray, toToRelationshipArray, toToRelationshipEndArray

- Field Detail
  - 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_CORRELATION_PROPERTIES
```
static final java.lang.String PROP_CORRELATION_PROPERTIES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - 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
  - addCorrelationProperty
```
void addCorrelationProperty(IBPCorrelationProperty correlationProperty)
```
  - removeCorrelationProperty
```
void removeCorrelationProperty(IBPCorrelationProperty correlationProperty)
```
  - getCorrelationPropertyByIndex
```
IBPCorrelationProperty getCorrelationPropertyByIndex(int index)
```
  - removeCorrelationPropertyByIndex
```
void removeCorrelationPropertyByIndex(int index)
```
  - correlationPropertyCount
```
int correlationPropertyCount()
```
  - correlationPropertyIterator
```
java.util.Iterator correlationPropertyIterator()
```
    Returns an iterator over the model elements IBPCorrelationProperty.
  - toCorrelationPropertyArray
```
IBPCorrelationProperty[] toCorrelationPropertyArray()
```

Interface IBPCorrelationKey

Field Summary

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

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

Method Summary

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

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

Field Detail

PROP_QUALITY_SCORE

PROP_QUALITY_REASON

PROP_CORRELATION_PROPERTIES

Method Detail

setQualityScore

getQualityScore

setQualityReason

getQualityReason

addCorrelationProperty

removeCorrelationProperty

getCorrelationPropertyByIndex

removeCorrelationPropertyByIndex

correlationPropertyCount

correlationPropertyIterator

toCorrelationPropertyArray