IInteractionOperand

All Superinterfaces:

IHasChildrenBaseModelElement, IModelElement, IModelElementParent
```
public interface IInteractionOperand
extends IHasChildrenBaseModelElement
```

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_GUARD`
`static java.lang.String`	`PROP_MESSAGES`
`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`	`addCombinedFragment(ICombinedFragment child)`
`void`	`addContinuation(IContinuation child)`
`void`	`addInteractionOccurrence(IInteractionOccurrence child)`
`void`	`addMessage(IMessage message)`
`void`	`addNOTE(INOTE child)`
`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`	`combinedFragmentCount()`
`java.util.Iterator`	`combinedFragmentIterator()`
`int`	`continuationCount()`
`java.util.Iterator`	`continuationIterator()`
`ICombinedFragment`	`createCombinedFragment()`
`IContinuation`	`createContinuation()`
`IInteractionOccurrence`	`createInteractionOccurrence()`
`INOTE`	`createNOTE()`
`java.lang.String[]`	`getAnalysisItemDiagramIds()`
`IModelElement`	`getAnalysisItemModelByIndex(int index)`
`ICombinedFragment`	`getCombinedFragmentByIndex(int index)`
`ICombinedFragment`	`getCombinedFragmentByName(java.lang.String name)`
`IContinuation`	`getContinuationByIndex(int index)`
`IContinuation`	`getContinuationByName(java.lang.String name)`
`IInteractionConstraint`	`getGuard()`
`IInteractionOccurrence`	`getInteractionOccurrenceByIndex(int index)`
`IInteractionOccurrence`	`getInteractionOccurrenceByName(java.lang.String name)`
`IMessage`	`getMessageByIndex(int index)`
`INOTE`	`getNOTEByIndex(int index)`
`INOTE`	`getNOTEByName(java.lang.String name)`
`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
`int`	`interactionOccurrenceCount()`
`java.util.Iterator`	`interactionOccurrenceIterator()`
`int`	`messageCount()`
`java.util.Iterator`	`messageIterator()` Returns an iterator over the model elements `IMessage`.
`int`	`nOTECount()`
`java.util.Iterator`	`nOTEIterator()`
`void`	`removeAnalysisItemModel(IModelElement analysisItemModel)`
`void`	`removeAnalysisItemModelByIndex(int index)`
`void`	`removeCombinedFragment(ICombinedFragment child)`
`void`	`removeCombinedFragmentByIndex(int index)`
`void`	`removeContinuation(IContinuation child)`
`void`	`removeContinuationByIndex(int index)`
`void`	`removeInteractionOccurrence(IInteractionOccurrence child)`
`void`	`removeInteractionOccurrenceByIndex(int index)`
`void`	`removeMessage(IMessage message)`
`void`	`removeMessageByIndex(int index)`
`void`	`removeNOTE(INOTE child)`
`void`	`removeNOTEByIndex(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`	`reorderCombinedFragment(ICombinedFragment[] childs)`
`void`	`reorderContinuation(IContinuation[] childs)`
`void`	`reorderInteractionOccurrence(IInteractionOccurrence[] childs)`
`void`	`reorderNOTE(INOTE[] childs)`
`void`	`setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)`
`void`	`setGuard(IInteractionConstraint guard)`
`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()`
`ICombinedFragment[]`	`toCombinedFragmentArray()`
`IContinuation[]`	`toContinuationArray()`
`IInteractionOccurrence[]`	`toInteractionOccurrenceArray()`
`IMessage[]`	`toMessageArray()`
`INOTE[]`	`toNOTEArray()`
`java.lang.String[]`	`toStereotypeArray()`
`IStereotype[]`	`toStereotypeModelArray()`
`java.lang.String[]`	`toStereotypesArray()` Deprecated. Replaced by toStereotypeArray
`IStereotype[]`	`toStereotypesModelArray()` Deprecated. Replaced by toStereotypeModelArray
`IModelElement[]`	`toSyncMappingModelArray()`

Methods inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement
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, 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, indexOfSubDiagram, isMirrorModelElement, isTransientModel, removeChild, removeChildByIndex, removePropertyChangeListener, removeSubDiagram, setDocumentation, setHTMLDocumentation, setName, setNickDescription, setNickDocumentation, setNickHTMLDescription, setNickHTMLDocumentation, setNickname, subDiagramCount, subDiagramIterator, toChartRelationshipCount, toChartRelationshipIterator, toChildArray, toChildArray, toChildArray, toFromChartRelationshipArray, toFromRelationshipArray, toFromRelationshipEndArray, toModelPropertyArray, toPropertiesString, toRelationshipCount, toRelationshipEndCount, toRelationshipEndIterator, toRelationshipIterator, toSubDiagramArray, toToChartRelationshipArray, toToRelationshipArray, toToRelationshipEndArray

- 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_MESSAGES
```
static final java.lang.String PROP_MESSAGES
```
    See Also:
    
    Constant Field Values
  - PROP_GUARD
```
static final java.lang.String PROP_GUARD
```
    See Also:
    
    Constant Field Values
- Method Detail
  - addCombinedFragment
```
void addCombinedFragment(ICombinedFragment child)
```
  - removeCombinedFragment
```
void removeCombinedFragment(ICombinedFragment child)
```
  - getCombinedFragmentByIndex
```
ICombinedFragment getCombinedFragmentByIndex(int index)
```
  - removeCombinedFragmentByIndex
```
void removeCombinedFragmentByIndex(int index)
```
  - reorderCombinedFragment
```
void reorderCombinedFragment(ICombinedFragment[] childs)
```
  - combinedFragmentCount
```
int combinedFragmentCount()
```
  - combinedFragmentIterator
```
java.util.Iterator combinedFragmentIterator()
```
  - toCombinedFragmentArray
```
ICombinedFragment[] toCombinedFragmentArray()
```
  - createCombinedFragment
```
ICombinedFragment createCombinedFragment()
```
  - getCombinedFragmentByName
```
ICombinedFragment getCombinedFragmentByName(java.lang.String name)
```
  - addContinuation
```
void addContinuation(IContinuation child)
```
  - removeContinuation
```
void removeContinuation(IContinuation child)
```
  - getContinuationByIndex
```
IContinuation getContinuationByIndex(int index)
```
  - removeContinuationByIndex
```
void removeContinuationByIndex(int index)
```
  - reorderContinuation
```
void reorderContinuation(IContinuation[] childs)
```
  - continuationCount
```
int continuationCount()
```
  - continuationIterator
```
java.util.Iterator continuationIterator()
```
  - toContinuationArray
```
IContinuation[] toContinuationArray()
```
  - createContinuation
```
IContinuation createContinuation()
```
  - getContinuationByName
```
IContinuation getContinuationByName(java.lang.String name)
```
  - addNOTE
```
void addNOTE(INOTE child)
```
  - removeNOTE
```
void removeNOTE(INOTE child)
```
  - getNOTEByIndex
```
INOTE getNOTEByIndex(int index)
```
  - removeNOTEByIndex
```
void removeNOTEByIndex(int index)
```
  - reorderNOTE
```
void reorderNOTE(INOTE[] childs)
```
  - nOTECount
```
int nOTECount()
```
  - nOTEIterator
```
java.util.Iterator nOTEIterator()
```
  - toNOTEArray
```
INOTE[] toNOTEArray()
```
  - createNOTE
```
INOTE createNOTE()
```
  - getNOTEByName
```
INOTE getNOTEByName(java.lang.String name)
```
  - addInteractionOccurrence
```
void addInteractionOccurrence(IInteractionOccurrence child)
```
  - removeInteractionOccurrence
```
void removeInteractionOccurrence(IInteractionOccurrence child)
```
  - getInteractionOccurrenceByIndex
```
IInteractionOccurrence getInteractionOccurrenceByIndex(int index)
```
  - removeInteractionOccurrenceByIndex
```
void removeInteractionOccurrenceByIndex(int index)
```
  - reorderInteractionOccurrence
```
void reorderInteractionOccurrence(IInteractionOccurrence[] childs)
```
  - interactionOccurrenceCount
```
int interactionOccurrenceCount()
```
  - interactionOccurrenceIterator
```
java.util.Iterator interactionOccurrenceIterator()
```
  - toInteractionOccurrenceArray
```
IInteractionOccurrence[] toInteractionOccurrenceArray()
```
  - createInteractionOccurrence
```
IInteractionOccurrence createInteractionOccurrence()
```
  - getInteractionOccurrenceByName
```
IInteractionOccurrence getInteractionOccurrenceByName(java.lang.String name)
```
  - 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
  - addMessage
```
void addMessage(IMessage message)
```
  - removeMessage
```
void removeMessage(IMessage message)
```
  - getMessageByIndex
```
IMessage getMessageByIndex(int index)
```
  - removeMessageByIndex
```
void removeMessageByIndex(int index)
```
  - messageCount
```
int messageCount()
```
  - messageIterator
```
java.util.Iterator messageIterator()
```
    Returns an iterator over the model elements IMessage.
  - toMessageArray
```
IMessage[] toMessageArray()
```
  - setGuard
```
void setGuard(IInteractionConstraint guard)
```
  - getGuard
```
IInteractionConstraint getGuard()
```

Interface IInteractionOperand

Field Summary

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

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

Method Summary

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

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_MESSAGES

PROP_GUARD

Method Detail

addCombinedFragment

removeCombinedFragment

getCombinedFragmentByIndex

removeCombinedFragmentByIndex

reorderCombinedFragment

combinedFragmentCount

combinedFragmentIterator

toCombinedFragmentArray

createCombinedFragment

getCombinedFragmentByName

addContinuation

removeContinuation

getContinuationByIndex

removeContinuationByIndex

reorderContinuation

continuationCount

continuationIterator

toContinuationArray

createContinuation

getContinuationByName

addNOTE

removeNOTE

getNOTEByIndex

removeNOTEByIndex

reorderNOTE

nOTECount

nOTEIterator

toNOTEArray

createNOTE

getNOTEByName

addInteractionOccurrence

removeInteractionOccurrence

getInteractionOccurrenceByIndex

removeInteractionOccurrenceByIndex

reorderInteractionOccurrence

interactionOccurrenceCount

interactionOccurrenceIterator

toInteractionOccurrenceArray

createInteractionOccurrence

getInteractionOccurrenceByName

addStereotype

removeStereotype

addStereotype

removeStereotype

hasStereotype

stereotypeCount

toStereotypeArray

stereotypeIterator

stereotypeModelIterator

toStereotypeModelArray

addStereotypes

removeStereotypes

hasStereotypes

stereotypesCount

toStereotypesArray

stereotypesIterator

stereotypesModelIterator

toStereotypesModelArray

setTaggedValues

getTaggedValues

addSyncMappingModel

removeSyncMappingModel