IHasRelationshipBaseEndRelationship

All Superinterfaces:

IEndRelationship, IModelElement, IModelElementParent, IRelationship

All Known Subinterfaces:

IAssociation, IMessage
```
public interface IHasRelationshipBaseEndRelationship
extends IEndRelationship
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_BACKLOG_ACTIVITY_ID`
`static java.lang.String`	`PROP_COMMENTS`
`static java.lang.String`	`PROP_DOCUMENTATION`
`static java.lang.String`	`PROP_GENERIC_VALUES`
`static java.lang.String`	`PROP_PM_AUTHOR`
`static java.lang.String`	`PROP_PM_CREATE_DATE_TIME`
`static java.lang.String`	`PROP_PM_DIFFICULTY`
`static java.lang.String`	`PROP_PM_DISCIPLINE`
`static java.lang.String`	`PROP_PM_ITERATION`
`static java.lang.String`	`PROP_PM_LAST_MODIFIED`
`static java.lang.String`	`PROP_PM_PHASE`
`static java.lang.String`	`PROP_PM_PRIORITY`
`static java.lang.String`	`PROP_PM_STATUS`
`static java.lang.String`	`PROP_PM_VERSION`
`static java.lang.String`	`PROP_REFERENCED_BY_DIAGRAM_IDS`
`static java.lang.String`	`PROP_REFERENCED_BY_MODEL_ADDRESSES`
`static java.lang.String`	`PROP_REFERENCES`
`static java.lang.String`	`PROP_TRANSIT_FROM`
`static java.lang.String`	`PROP_TRANSIT_TO`
`static java.lang.String`	`PROP_USER_ID`
`static java.lang.String`	`PROP_USER_ID_LAST_NUMERIC_VALUE`
`static java.lang.String`	`PROP_USER_ID_PARENT`
`static java.lang.String`	`PROP_VOICES`

Fields inherited from interface com.vp.plugin.model.IEndRelationship
PROP_FROM, PROP_FROM_MODEL, PROP_TO, PROP_TO_MODEL

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

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addComment(IComment comment)`
`void`	`addGenericValue(IGenericValue genericValue)`
`void`	`addReference(IReference reference)`
`void`	`addVoice(IVoice voice)`
`int`	`commentCount()`
`java.util.Iterator`	`commentIterator()` Returns an iterator over the model elements `IComment`.
`int`	`genericValueCount()`
`java.util.Iterator`	`genericValueIterator()` Returns an iterator over the model elements `IGenericValue`.
`int`	`getBacklogActivityId()`
`IComment`	`getCommentByIndex(int index)`
`java.lang.String`	`getDescription()`
`IGenericValue`	`getGenericValueByIndex(int index)`
`java.lang.String`	`getHTMLDescription()`
`java.lang.String`	`getHTMLDescription(boolean convertPlainTextToHTML)`
`java.lang.String`	`getPmAuthor()`
`java.lang.String`	`getPmCreateDateTime()`
`IPMDifficulty`	`getPmDifficulty()`
`IPMDiscipline`	`getPmDiscipline()`
`IPMIteration`	`getPmIteration()`
`java.lang.String`	`getPmLastModified()`
`IPMPhase`	`getPmPhase()`
`IPMPriority`	`getPmPriority()`
`IPMStatus`	`getPmStatus()`
`IPMVersion`	`getPmVersion()`
`IReference`	`getReferenceByIndex(int index)`
`java.lang.String[]`	`getReferencedByDiagramIds()`
`java.lang.String[]`	`getReferencedByModelAddresses()`
`java.lang.String`	`getTransitFrom()` Deprecated. Replaced by `ITransitProperty`, please refer to #getModelPropertyByName(PROP_TRANSIT_FROM)
`java.lang.String`	`getTransitTo()` Deprecated. Replaced by `ITransitProperty`, please refer to #getModelPropertyByName(PROP_TRANSIT_TO)
`java.lang.String`	`getUserID()`
`int`	`getUserIDLastNumericValue()`
`java.lang.String`	`getUserIDParent()`
`IVoice`	`getVoiceByIndex(int index)`
`int`	`referenceCount()`
`java.util.Iterator`	`referenceIterator()` Returns an iterator over the model elements `IReference`.
`void`	`removeComment(IComment comment)`
`void`	`removeCommentByIndex(int index)`
`void`	`removeGenericValue(IGenericValue genericValue)`
`void`	`removeGenericValueByIndex(int index)`
`void`	`removeReference(IReference reference)`
`void`	`removeReferenceByIndex(int index)`
`void`	`removeVoice(IVoice voice)`
`void`	`removeVoiceByIndex(int index)`
`void`	`setBacklogActivityId(int backlogActivityId)`
`void`	`setDescription(java.lang.String description)`
`void`	`setHTMLDescription(java.lang.String description)`
`void`	`setPmAuthor(java.lang.String pmAuthor)`
`void`	`setPmCreateDateTime(java.lang.String pmCreateDateTime)`
`void`	`setPmDifficulty(IPMDifficulty pmDifficulty)`
`void`	`setPmDiscipline(IPMDiscipline pmDiscipline)`
`void`	`setPmIteration(IPMIteration pmIteration)`
`void`	`setPmLastModified(java.lang.String pmLastModified)`
`void`	`setPmPhase(IPMPhase pmPhase)`
`void`	`setPmPriority(IPMPriority pmPriority)`
`void`	`setPmStatus(IPMStatus pmStatus)`
`void`	`setPmVersion(IPMVersion pmVersion)`
`void`	`setReferencedByDiagramIds(java.lang.String[] referencedByDiagramIds)`
`void`	`setReferencedByModelAddresses(java.lang.String[] referencedByModelAddresses)`
`void`	`setTransitFrom(java.lang.String transitFrom)` Deprecated. Replaced by `ITransitProperty`, please refer to #getModelPropertyByName(PROP_TRANSIT_FROM)
`void`	`setTransitTo(java.lang.String transitTo)` Deprecated. Replaced by `ITransitProperty`, please refer to #getModelPropertyByName(PROP_TRANSIT_TO)
`void`	`setUserID(java.lang.String userID)`
`void`	`setUserIDLastNumericValue(int userIDLastNumericValue)`
`void`	`setUserIDParent(java.lang.String userIDParent)`
`IComment[]`	`toCommentArray()`
`IGenericValue[]`	`toGenericValueArray()`
`IReference[]`	`toReferenceArray()`
`IVoice[]`	`toVoiceArray()`
`int`	`voiceCount()`
`java.util.Iterator`	`voiceIterator()` Returns an iterator over the model elements `IVoice`.

Methods inherited from interface com.vp.plugin.model.IEndRelationship
getFromEnd, getToEnd

Methods inherited from interface com.vp.plugin.model.IRelationship
getFrom, getTo, setFrom, setTo

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, getQualityReason, getQualityScore, 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_COMMENTS

static final java.lang.String PROP_COMMENTS

See Also:: Constant Field Values

PROP_DOCUMENTATION

static final java.lang.String PROP_DOCUMENTATION

See Also:: Constant Field Values

PROP_VOICES

static final java.lang.String PROP_VOICES

See Also:: Constant Field Values

PROP_REFERENCES

static final java.lang.String PROP_REFERENCES

See Also:: Constant Field Values

PROP_REFERENCED_BY_DIAGRAM_IDS

static final java.lang.String PROP_REFERENCED_BY_DIAGRAM_IDS

See Also:: Constant Field Values

PROP_REFERENCED_BY_MODEL_ADDRESSES

static final java.lang.String PROP_REFERENCED_BY_MODEL_ADDRESSES

See Also:: Constant Field Values

PROP_TRANSIT_FROM

static final java.lang.String PROP_TRANSIT_FROM

See Also:: Constant Field Values

PROP_TRANSIT_TO

static final java.lang.String PROP_TRANSIT_TO

See Also:: Constant Field Values

PROP_PM_STATUS

static final java.lang.String PROP_PM_STATUS

See Also:: Constant Field Values

PROP_PM_DIFFICULTY

static final java.lang.String PROP_PM_DIFFICULTY

See Also:: Constant Field Values

PROP_PM_PRIORITY

static final java.lang.String PROP_PM_PRIORITY

See Also:: Constant Field Values

PROP_PM_VERSION

static final java.lang.String PROP_PM_VERSION

See Also:: Constant Field Values

PROP_PM_ITERATION

static final java.lang.String PROP_PM_ITERATION

See Also:: Constant Field Values

PROP_PM_PHASE

static final java.lang.String PROP_PM_PHASE

See Also:: Constant Field Values

PROP_PM_DISCIPLINE

static final java.lang.String PROP_PM_DISCIPLINE

See Also:: Constant Field Values

PROP_PM_AUTHOR

static final java.lang.String PROP_PM_AUTHOR

See Also:: Constant Field Values

PROP_PM_CREATE_DATE_TIME

static final java.lang.String PROP_PM_CREATE_DATE_TIME

See Also:: Constant Field Values

PROP_PM_LAST_MODIFIED

static final java.lang.String PROP_PM_LAST_MODIFIED

See Also:: Constant Field Values

PROP_USER_ID

static final java.lang.String PROP_USER_ID

See Also:: Constant Field Values

PROP_USER_ID_PARENT

static final java.lang.String PROP_USER_ID_PARENT

See Also:: Constant Field Values

PROP_USER_ID_LAST_NUMERIC_VALUE

static final java.lang.String PROP_USER_ID_LAST_NUMERIC_VALUE

See Also:: Constant Field Values

PROP_BACKLOG_ACTIVITY_ID

static final java.lang.String PROP_BACKLOG_ACTIVITY_ID

See Also:: Constant Field Values

PROP_GENERIC_VALUES

static final java.lang.String PROP_GENERIC_VALUES

See Also:: Constant Field Values

Method Detail

setTransitFrom
```
void setTransitFrom(java.lang.String transitFrom)
```
Deprecated. Replaced by ITransitProperty, please refer to #getModelPropertyByName(PROP_TRANSIT_FROM)

getTransitFrom
```
java.lang.String getTransitFrom()
```
Deprecated. Replaced by ITransitProperty, please refer to #getModelPropertyByName(PROP_TRANSIT_FROM)

setTransitTo
```
void setTransitTo(java.lang.String transitTo)
```
Deprecated. Replaced by ITransitProperty, please refer to #getModelPropertyByName(PROP_TRANSIT_TO)

getTransitTo
```
java.lang.String getTransitTo()
```
Deprecated. Replaced by ITransitProperty, please refer to #getModelPropertyByName(PROP_TRANSIT_TO)

addComment
```
void addComment(IComment comment)
```

removeComment
```
void removeComment(IComment comment)
```

getCommentByIndex
```
IComment getCommentByIndex(int index)
```

removeCommentByIndex
```
void removeCommentByIndex(int index)
```

commentCount
```
int commentCount()
```

commentIterator
```
java.util.Iterator commentIterator()
```
Returns an iterator over the model elements IComment.

toCommentArray
```
IComment[] toCommentArray()
```

setDescription
```
void setDescription(java.lang.String description)
```
Specified by:

setDescription in interface IModelElement

getDescription
```
java.lang.String getDescription()
```
Specified by:

getDescription in interface IModelElement

setHTMLDescription
```
void setHTMLDescription(java.lang.String description)
```
Specified by:

setHTMLDescription in interface IModelElement

getHTMLDescription
```
java.lang.String getHTMLDescription()
```
Specified by:

getHTMLDescription in interface IModelElement

getHTMLDescription
```
java.lang.String getHTMLDescription(boolean convertPlainTextToHTML)
```
Specified by:

getHTMLDescription in interface IModelElement

addVoice
```
void addVoice(IVoice voice)
```

removeVoice
```
void removeVoice(IVoice voice)
```

getVoiceByIndex
```
IVoice getVoiceByIndex(int index)
```

removeVoiceByIndex
```
void removeVoiceByIndex(int index)
```

voiceCount
```
int voiceCount()
```

voiceIterator
```
java.util.Iterator voiceIterator()
```
Returns an iterator over the model elements IVoice.

toVoiceArray
```
IVoice[] toVoiceArray()
```

addReference

void addReference(IReference reference)

removeReference

void removeReference(IReference reference)

getReferenceByIndex

IReference getReferenceByIndex(int index)

removeReferenceByIndex

void removeReferenceByIndex(int index)

referenceCount
```
int referenceCount()
```

referenceIterator
```
java.util.Iterator referenceIterator()
```
Returns an iterator over the model elements IReference.

toReferenceArray
```
IReference[] toReferenceArray()
```

setReferencedByDiagramIds

void setReferencedByDiagramIds(java.lang.String[] referencedByDiagramIds)

getReferencedByDiagramIds

java.lang.String[] getReferencedByDiagramIds()

setReferencedByModelAddresses

void setReferencedByModelAddresses(java.lang.String[] referencedByModelAddresses)

getReferencedByModelAddresses

java.lang.String[] getReferencedByModelAddresses()

setPmStatus
```
void setPmStatus(IPMStatus pmStatus)
```

getPmStatus
```
IPMStatus getPmStatus()
```

setPmDifficulty

void setPmDifficulty(IPMDifficulty pmDifficulty)

getPmDifficulty
```
IPMDifficulty getPmDifficulty()
```

setPmPriority

void setPmPriority(IPMPriority pmPriority)

getPmPriority
```
IPMPriority getPmPriority()
```

setPmVersion

void setPmVersion(IPMVersion pmVersion)

getPmVersion
```
IPMVersion getPmVersion()
```

setPmIteration

void setPmIteration(IPMIteration pmIteration)

getPmIteration
```
IPMIteration getPmIteration()
```

setPmPhase
```
void setPmPhase(IPMPhase pmPhase)
```

getPmPhase
```
IPMPhase getPmPhase()
```

setPmDiscipline

void setPmDiscipline(IPMDiscipline pmDiscipline)

getPmDiscipline
```
IPMDiscipline getPmDiscipline()
```

setPmAuthor

void setPmAuthor(java.lang.String pmAuthor)

getPmAuthor
```
java.lang.String getPmAuthor()
```

setPmCreateDateTime

void setPmCreateDateTime(java.lang.String pmCreateDateTime)

getPmCreateDateTime
```
java.lang.String getPmCreateDateTime()
```

setPmLastModified

void setPmLastModified(java.lang.String pmLastModified)

getPmLastModified
```
java.lang.String getPmLastModified()
```

setUserID

void setUserID(java.lang.String userID)

getUserID
```
java.lang.String getUserID()
```

setUserIDParent

void setUserIDParent(java.lang.String userIDParent)

getUserIDParent
```
java.lang.String getUserIDParent()
```

setUserIDLastNumericValue

void setUserIDLastNumericValue(int userIDLastNumericValue)

getUserIDLastNumericValue
```
int getUserIDLastNumericValue()
```

setBacklogActivityId

void setBacklogActivityId(int backlogActivityId)

getBacklogActivityId
```
int getBacklogActivityId()
```

addGenericValue

void addGenericValue(IGenericValue genericValue)

removeGenericValue

void removeGenericValue(IGenericValue genericValue)

getGenericValueByIndex

IGenericValue getGenericValueByIndex(int index)

removeGenericValueByIndex

void removeGenericValueByIndex(int index)

genericValueCount
```
int genericValueCount()
```

genericValueIterator
```
java.util.Iterator genericValueIterator()
```
Returns an iterator over the model elements IGenericValue.

toGenericValueArray
```
IGenericValue[] toGenericValueArray()
```

Interface IHasRelationshipBaseEndRelationship

Field Summary

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

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

Method Summary

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

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

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

Field Detail

PROP_COMMENTS

PROP_DOCUMENTATION

PROP_VOICES

PROP_REFERENCES

PROP_REFERENCED_BY_DIAGRAM_IDS

PROP_REFERENCED_BY_MODEL_ADDRESSES

PROP_TRANSIT_FROM

PROP_TRANSIT_TO

PROP_PM_STATUS

PROP_PM_DIFFICULTY

PROP_PM_PRIORITY

PROP_PM_VERSION

PROP_PM_ITERATION

PROP_PM_PHASE

PROP_PM_DISCIPLINE

PROP_PM_AUTHOR

PROP_PM_CREATE_DATE_TIME

PROP_PM_LAST_MODIFIED

PROP_USER_ID

PROP_USER_ID_PARENT

PROP_USER_ID_LAST_NUMERIC_VALUE

PROP_BACKLOG_ACTIVITY_ID

PROP_GENERIC_VALUES

Method Detail

setTransitFrom

getTransitFrom

setTransitTo

getTransitTo

addComment

removeComment

getCommentByIndex

removeCommentByIndex

commentCount

commentIterator

toCommentArray

setDescription

getDescription

setHTMLDescription

getHTMLDescription

getHTMLDescription

addVoice

removeVoice

getVoiceByIndex

removeVoiceByIndex

voiceCount

voiceIterator

toVoiceArray

addReference

removeReference

getReferenceByIndex

removeReferenceByIndex

referenceCount

referenceIterator

toReferenceArray

setReferencedByDiagramIds

getReferencedByDiagramIds

setReferencedByModelAddresses

getReferencedByModelAddresses

setPmStatus

getPmStatus

setPmDifficulty

getPmDifficulty

setPmPriority

getPmPriority

setPmVersion

getPmVersion

setPmIteration

getPmIteration

setPmPhase

getPmPhase

setPmDiscipline