com.vp.plugin.model

Interface IConversationContainer

All Superinterfaces:

IHasChildrenBaseModelElement, IModelElement, IModelElementParent

public interface IConversationContainer
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_CHECK_LIST_ITEMS
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.IHasChildrenBaseModelElement

PROP_BACKLOG_ACTIVITY_ID, PROP_COMMENTS, PROP_DOCUMENTATION, PROP_GENERIC_VALUES, PROP_PM_AUTHOR, PROP_PM_CREATE_DATE_TIME, PROP_PM_DIFFICULTY, PROP_PM_DISCIPLINE, PROP_PM_ITERATION, PROP_PM_LAST_MODIFIED, PROP_PM_PHASE, PROP_PM_PRIORITY, PROP_PM_STATUS, PROP_PM_VERSION, PROP_REFERENCED_BY_DIAGRAM_IDS, PROP_REFERENCED_BY_MODEL_ADDRESSES, PROP_REFERENCES, PROP_TRANSIT_FROM, PROP_TRANSIT_TO, PROP_USER_ID, PROP_USER_ID_LAST_NUMERIC_VALUE, PROP_USER_ID_PARENT, PROP_VOICES

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

MODEL_QUALITY_SCORE_IGNORE, MODEL_QUALITY_SCORE_RECALCULATE, PROP_NAME

Method Summary

Modifier and Type	Method and Description
void	addAnalysisItemModel(IModelElement analysisItemModel)
void	addBPAssociation(IBPAssociation child)
void	addBPGroup(IBPGroup child)
void	addBPPool(IBPPool child)
void	addBPTextAnnotation(IBPTextAnnotation child)
void	addCallConversation(ICallConversation child)
void	addConversationCommunication(IConversationCommunication child)
void	addConversationLink(IConversationLink 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	addSubConversation(ISubConversation child)
void	addSyncMappingModel(IModelElement syncMappingModel)
int	analysisItemModelCount()
java.util.Iterator	analysisItemModelIterator() Returns an iterator over the model elements IModelElement.
int	bPAssociationCount()
java.util.Iterator	bPAssociationIterator()
int	bPGroupCount()
java.util.Iterator	bPGroupIterator()
int	bPPoolCount()
java.util.Iterator	bPPoolIterator()
int	bPTextAnnotationCount()
java.util.Iterator	bPTextAnnotationIterator()
int	callConversationCount()
java.util.Iterator	callConversationIterator()
int	conversationCommunicationCount()
java.util.Iterator	conversationCommunicationIterator()
int	conversationLinkCount()
java.util.Iterator	conversationLinkIterator()
IBPAssociation	createBPAssociation()
IBPGroup	createBPGroup()
IBPPool	createBPPool()
IBPTextAnnotation	createBPTextAnnotation()
ICallConversation	createCallConversation()
IConversationCommunication	createConversationCommunication()
IConversationLink	createConversationLink()
ISubConversation	createSubConversation()
java.lang.String[]	getAnalysisItemDiagramIds()
IModelElement	getAnalysisItemModelByIndex(int index)
IBPAssociation	getBPAssociationByIndex(int index)
IBPAssociation	getBPAssociationByName(java.lang.String name)
IBPGroup	getBPGroupByIndex(int index)
IBPGroup	getBPGroupByName(java.lang.String name)
IBPPool	getBPPoolByIndex(int index)
IBPPool	getBPPoolByName(java.lang.String name)
IBPTextAnnotation	getBPTextAnnotationByIndex(int index)
IBPTextAnnotation	getBPTextAnnotationByName(java.lang.String name)
ICallConversation	getCallConversationByIndex(int index)
ICallConversation	getCallConversationByName(java.lang.String name)
ICheckListItemContainer	getCheckListItems()
IConversationCommunication	getConversationCommunicationByIndex(int index)
IConversationCommunication	getConversationCommunicationByName(java.lang.String name)
IConversationLink	getConversationLinkByIndex(int index)
IConversationLink	getConversationLinkByName(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
ISubConversation	getSubConversationByIndex(int index)
ISubConversation	getSubConversationByName(java.lang.String name)
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	removeBPAssociation(IBPAssociation child)
void	removeBPAssociationByIndex(int index)
void	removeBPGroup(IBPGroup child)
void	removeBPGroupByIndex(int index)
void	removeBPPool(IBPPool child)
void	removeBPPoolByIndex(int index)
void	removeBPTextAnnotation(IBPTextAnnotation child)
void	removeBPTextAnnotationByIndex(int index)
void	removeCallConversation(ICallConversation child)
void	removeCallConversationByIndex(int index)
void	removeConversationCommunication(IConversationCommunication child)
void	removeConversationCommunicationByIndex(int index)
void	removeConversationLink(IConversationLink child)
void	removeConversationLinkByIndex(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	removeSubConversation(ISubConversation child)
void	removeSubConversationByIndex(int index)
void	removeSyncMappingModel(IModelElement syncMappingModel)
void	removeSyncMappingModelByIndex(int index)
void	reorderBPAssociation(IBPAssociation[] childs)
void	reorderBPGroup(IBPGroup[] childs)
void	reorderBPPool(IBPPool[] childs)
void	reorderBPTextAnnotation(IBPTextAnnotation[] childs)
void	reorderCallConversation(ICallConversation[] childs)
void	reorderConversationCommunication(IConversationCommunication[] childs)
void	reorderConversationLink(IConversationLink[] childs)
void	reorderSubConversation(ISubConversation[] childs)
void	setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)
void	setCheckListItems(ICheckListItemContainer checkListItems)
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	subConversationCount()
java.util.Iterator	subConversationIterator()
int	syncMappingModelCount()
java.util.Iterator	syncMappingModelIterator() Returns an iterator over the model elements IModelElement.
IModelElement[]	toAnalysisItemModelArray()
IBPAssociation[]	toBPAssociationArray()
IBPGroup[]	toBPGroupArray()
IBPPool[]	toBPPoolArray()
IBPTextAnnotation[]	toBPTextAnnotationArray()
ICallConversation[]	toCallConversationArray()
IConversationCommunication[]	toConversationCommunicationArray()
IConversationLink[]	toConversationLinkArray()
java.lang.String[]	toStereotypeArray()
IStereotype[]	toStereotypeModelArray()
java.lang.String[]	toStereotypesArray() Deprecated. Replaced by toStereotypeArray
IStereotype[]	toStereotypesModelArray() Deprecated. Replaced by toStereotypeModelArray
ISubConversation[]	toSubConversationArray()
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_CHECK_LIST_ITEMS

static final java.lang.String PROP_CHECK_LIST_ITEMS

See Also:

Constant Field Values

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

Method Detail

addConversationCommunication

void addConversationCommunication(IConversationCommunication child)

removeConversationCommunication

void removeConversationCommunication(IConversationCommunication child)

getConversationCommunicationByIndex

IConversationCommunication getConversationCommunicationByIndex(int index)

removeConversationCommunicationByIndex

void removeConversationCommunicationByIndex(int index)

reorderConversationCommunication

void reorderConversationCommunication(IConversationCommunication[] childs)

conversationCommunicationCount

int conversationCommunicationCount()

conversationCommunicationIterator

java.util.Iterator conversationCommunicationIterator()

toConversationCommunicationArray

IConversationCommunication[] toConversationCommunicationArray()

createConversationCommunication

IConversationCommunication createConversationCommunication()

getConversationCommunicationByName

IConversationCommunication getConversationCommunicationByName(java.lang.String name)

addSubConversation

void addSubConversation(ISubConversation child)

removeSubConversation

void removeSubConversation(ISubConversation child)

getSubConversationByIndex

ISubConversation getSubConversationByIndex(int index)

removeSubConversationByIndex

void removeSubConversationByIndex(int index)

reorderSubConversation

void reorderSubConversation(ISubConversation[] childs)

subConversationCount

int subConversationCount()

subConversationIterator

java.util.Iterator subConversationIterator()

toSubConversationArray

ISubConversation[] toSubConversationArray()

createSubConversation

ISubConversation createSubConversation()

getSubConversationByName

ISubConversation getSubConversationByName(java.lang.String name)

addBPPool

void addBPPool(IBPPool child)

removeBPPool

void removeBPPool(IBPPool child)

getBPPoolByIndex

IBPPool getBPPoolByIndex(int index)

removeBPPoolByIndex

void removeBPPoolByIndex(int index)

reorderBPPool

void reorderBPPool(IBPPool[] childs)

bPPoolCount

int bPPoolCount()

bPPoolIterator

java.util.Iterator bPPoolIterator()

toBPPoolArray

IBPPool[] toBPPoolArray()

createBPPool

IBPPool createBPPool()

getBPPoolByName

IBPPool getBPPoolByName(java.lang.String name)

addBPAssociation

void addBPAssociation(IBPAssociation child)

removeBPAssociation

void removeBPAssociation(IBPAssociation child)

getBPAssociationByIndex

IBPAssociation getBPAssociationByIndex(int index)

removeBPAssociationByIndex

void removeBPAssociationByIndex(int index)

reorderBPAssociation

void reorderBPAssociation(IBPAssociation[] childs)

bPAssociationCount

int bPAssociationCount()

bPAssociationIterator

java.util.Iterator bPAssociationIterator()

toBPAssociationArray

IBPAssociation[] toBPAssociationArray()

createBPAssociation

IBPAssociation createBPAssociation()

getBPAssociationByName

IBPAssociation getBPAssociationByName(java.lang.String name)

addBPTextAnnotation

void addBPTextAnnotation(IBPTextAnnotation child)

removeBPTextAnnotation

void removeBPTextAnnotation(IBPTextAnnotation child)

getBPTextAnnotationByIndex

IBPTextAnnotation getBPTextAnnotationByIndex(int index)

removeBPTextAnnotationByIndex

void removeBPTextAnnotationByIndex(int index)

reorderBPTextAnnotation

void reorderBPTextAnnotation(IBPTextAnnotation[] childs)

bPTextAnnotationCount

int bPTextAnnotationCount()

bPTextAnnotationIterator

java.util.Iterator bPTextAnnotationIterator()

toBPTextAnnotationArray

IBPTextAnnotation[] toBPTextAnnotationArray()

createBPTextAnnotation

IBPTextAnnotation createBPTextAnnotation()

getBPTextAnnotationByName

IBPTextAnnotation getBPTextAnnotationByName(java.lang.String name)

addBPGroup

void addBPGroup(IBPGroup child)

removeBPGroup

void removeBPGroup(IBPGroup child)

getBPGroupByIndex

IBPGroup getBPGroupByIndex(int index)

removeBPGroupByIndex

void removeBPGroupByIndex(int index)

reorderBPGroup

void reorderBPGroup(IBPGroup[] childs)

bPGroupCount

int bPGroupCount()

bPGroupIterator

java.util.Iterator bPGroupIterator()

toBPGroupArray

IBPGroup[] toBPGroupArray()

createBPGroup

IBPGroup createBPGroup()

getBPGroupByName

IBPGroup getBPGroupByName(java.lang.String name)

addCallConversation

void addCallConversation(ICallConversation child)

removeCallConversation

void removeCallConversation(ICallConversation child)

getCallConversationByIndex

ICallConversation getCallConversationByIndex(int index)

removeCallConversationByIndex

void removeCallConversationByIndex(int index)

reorderCallConversation

void reorderCallConversation(ICallConversation[] childs)

callConversationCount

int callConversationCount()

callConversationIterator

java.util.Iterator callConversationIterator()

toCallConversationArray

ICallConversation[] toCallConversationArray()

createCallConversation

ICallConversation createCallConversation()

getCallConversationByName

ICallConversation getCallConversationByName(java.lang.String name)

addConversationLink

void addConversationLink(IConversationLink child)

removeConversationLink

void removeConversationLink(IConversationLink child)

getConversationLinkByIndex

IConversationLink getConversationLinkByIndex(int index)

removeConversationLinkByIndex

void removeConversationLinkByIndex(int index)

reorderConversationLink

void reorderConversationLink(IConversationLink[] childs)

conversationLinkCount

int conversationLinkCount()

conversationLinkIterator

java.util.Iterator conversationLinkIterator()

toConversationLinkArray

IConversationLink[] toConversationLinkArray()

createConversationLink

IConversationLink createConversationLink()

getConversationLinkByName

IConversationLink getConversationLinkByName(java.lang.String name)

setCheckListItems

void setCheckListItems(ICheckListItemContainer checkListItems)

getCheckListItems

ICheckListItemContainer getCheckListItems()

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