com.vp.plugin.model

Interface IBPProcess

All Superinterfaces:

IModelElement, IModelElementParent, INoChildrenNoRelationshipBaseModelElement

public interface IBPProcess
extends INoChildrenNoRelationshipBaseModelElement

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROCESS_TYPE_EXECUTABLE
static int	PROCESS_TYPE_NON_EXECUTABLE
static int	PROCESS_TYPE_NONE
static int	PROCESS_TYPE_PUBLIC
static java.lang.String	PROP_ANALYSIS_ITEM_DIAGRAM_IDS
static java.lang.String	PROP_ANALYSIS_ITEM_MODELS
static java.lang.String	PROP_ASSIGNMENTS
static java.lang.String	PROP_AUDITING
static java.lang.String	PROP_CATEGORIES
static java.lang.String	PROP_CHECK_LIST_ITEMS
static java.lang.String	PROP_CLOSED
static java.lang.String	PROP_ENABLE_INSTANCE_COMPENSATION
static java.lang.String	PROP_MONITORING
static java.lang.String	PROP_PROCESS_TYPE
static java.lang.String	PROP_PROPERTIES
static java.lang.String	PROP_QUALITY_REASON
static java.lang.String	PROP_QUALITY_SCORE
static java.lang.String	PROP_STATUS
static java.lang.String	PROP_STEREOTYPES
static java.lang.String	PROP_SUPPORTS
static java.lang.String	PROP_SUPPRESS_JOIN_FAILURE
static java.lang.String	PROP_SYNC_MAPPING_MODELS
static java.lang.String	PROP_TAGGED_VALUES
static int	STATUS_ABORTED
static int	STATUS_ABORTING
static int	STATUS_ACTIVE
static int	STATUS_CANCELED
static int	STATUS_CLOSED
static int	STATUS_COMPENSATED
static int	STATUS_COMPENSATING
static int	STATUS_COMPLETED
static int	STATUS_COMPLETING
static int	STATUS_FAILED
static int	STATUS_INACTIVE
static int	STATUS_NONE
static int	STATUS_READY
static int	STATUS_TERMINATED
static int	STATUS_WITHDRAWN

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

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	addAssignment(IBPAssignment assignment)
void	addProperty(IBPProperty property)
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	addSupport(IBPProcess support)
void	addSyncMappingModel(IModelElement syncMappingModel)
int	analysisItemModelCount()
java.util.Iterator	analysisItemModelIterator() Returns an iterator over the model elements IModelElement.
int	assignmentCount()
java.util.Iterator	assignmentIterator() Returns an iterator over the model elements IBPAssignment.
java.lang.String[]	getAnalysisItemDiagramIds()
IModelElement	getAnalysisItemModelByIndex(int index)
IBPAssignment	getAssignmentByIndex(int index)
IBPAuditing	getAuditing()
java.lang.String[]	getCategories()
ICheckListItemContainer	getCheckListItems()
IBPMonitoring	getMonitoring()
IBPParticipant	getParticipant()
int	getProcessType()
IBPProperty	getPropertyByIndex(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
int	getStatus()
IBPProcess	getSupportByIndex(int index)
IModelElement	getSyncMappingModelByIndex(int index)
ITaggedValueContainer	getTaggedValues()
boolean	hasStereotype(java.lang.String name)
boolean	hasStereotypes(java.lang.String name) Deprecated. Replaced by hasStereotype
boolean	isClosed()
boolean	isEnableInstanceCompensation()
boolean	isSuppressJoinFailure()
int	propertyCount()
java.util.Iterator	propertyIterator() Returns an iterator over the model elements IBPProperty.
void	removeAnalysisItemModel(IModelElement analysisItemModel)
void	removeAnalysisItemModelByIndex(int index)
void	removeAssignment(IBPAssignment assignment)
void	removeAssignmentByIndex(int index)
void	removeProperty(IBPProperty property)
void	removePropertyByIndex(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	removeSupport(IBPProcess support)
void	removeSupportByIndex(int index)
void	removeSyncMappingModel(IModelElement syncMappingModel)
void	removeSyncMappingModelByIndex(int index)
void	setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)
void	setAuditing(IBPAuditing auditing)
void	setCategories(java.lang.String[] categories)
void	setCheckListItems(ICheckListItemContainer checkListItems)
void	setClosed(boolean closed)
void	setEnableInstanceCompensation(boolean enableInstanceCompensation)
void	setMonitoring(IBPMonitoring monitoring)
void	setProcessType(int processType)
void	setQualityReason(java.lang.String qualityReason)
void	setQualityScore(int qualityScore)
void	setStatus(int status)
void	setSuppressJoinFailure(boolean suppressJoinFailure)
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	supportCount()
java.util.Iterator	supportIterator() Returns an iterator over the model elements IBPProcess.
int	syncMappingModelCount()
java.util.Iterator	syncMappingModelIterator() Returns an iterator over the model elements IModelElement.
IModelElement[]	toAnalysisItemModelArray()
IBPAssignment[]	toAssignmentArray()
IModelElement[]	toFlowElementArray()
IBPLane[]	toLaneArray()
IBPProperty[]	toPropertyArray()
java.lang.String[]	toStereotypeArray()
IStereotype[]	toStereotypeModelArray()
java.lang.String[]	toStereotypesArray() Deprecated. Replaced by toStereotypeArray
IStereotype[]	toStereotypesModelArray() Deprecated. Replaced by toStereotypeModelArray
IBPProcess[]	toSupportArray()
IModelElement[]	toSyncMappingModelArray()

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, 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

PROP_CATEGORIES

static final java.lang.String PROP_CATEGORIES

See Also:

Constant Field Values

PROP_ASSIGNMENTS

static final java.lang.String PROP_ASSIGNMENTS

See Also:

Constant Field Values

PROP_SUPPRESS_JOIN_FAILURE

static final java.lang.String PROP_SUPPRESS_JOIN_FAILURE

See Also:

Constant Field Values

PROP_ENABLE_INSTANCE_COMPENSATION

static final java.lang.String PROP_ENABLE_INSTANCE_COMPENSATION

See Also:

Constant Field Values

PROP_CLOSED

static final java.lang.String PROP_CLOSED

See Also:

Constant Field Values

PROP_MONITORING

static final java.lang.String PROP_MONITORING

See Also:

Constant Field Values

PROP_AUDITING

static final java.lang.String PROP_AUDITING

See Also:

Constant Field Values

PROP_SUPPORTS

static final java.lang.String PROP_SUPPORTS

See Also:

Constant Field Values

PROP_PROCESS_TYPE

static final java.lang.String PROP_PROCESS_TYPE

See Also:

Constant Field Values

PROCESS_TYPE_NONE

static final int PROCESS_TYPE_NONE

See Also:

Constant Field Values

PROCESS_TYPE_EXECUTABLE

static final int PROCESS_TYPE_EXECUTABLE

See Also:

Constant Field Values

PROCESS_TYPE_NON_EXECUTABLE

static final int PROCESS_TYPE_NON_EXECUTABLE

See Also:

Constant Field Values

PROCESS_TYPE_PUBLIC

static final int PROCESS_TYPE_PUBLIC

See Also:

Constant Field Values

PROP_PROPERTIES

static final java.lang.String PROP_PROPERTIES

See Also:

Constant Field Values

PROP_STATUS

static final java.lang.String PROP_STATUS

See Also:

Constant Field Values

STATUS_NONE

static final int STATUS_NONE

See Also:

Constant Field Values

STATUS_INACTIVE

static final int STATUS_INACTIVE

See Also:

Constant Field Values

STATUS_READY

static final int STATUS_READY

See Also:

Constant Field Values

STATUS_WITHDRAWN

static final int STATUS_WITHDRAWN

See Also:

Constant Field Values

STATUS_ACTIVE

static final int STATUS_ACTIVE

See Also:

Constant Field Values

STATUS_TERMINATED

static final int STATUS_TERMINATED

See Also:

Constant Field Values

STATUS_FAILED

static final int STATUS_FAILED

See Also:

Constant Field Values

STATUS_COMPLETING

static final int STATUS_COMPLETING

See Also:

Constant Field Values

STATUS_COMPLETED

static final int STATUS_COMPLETED

See Also:

Constant Field Values

STATUS_COMPENSATING

static final int STATUS_COMPENSATING

See Also:

Constant Field Values

STATUS_COMPENSATED

static final int STATUS_COMPENSATED

See Also:

Constant Field Values

STATUS_CANCELED

static final int STATUS_CANCELED

See Also:

Constant Field Values

STATUS_ABORTING

static final int STATUS_ABORTING

See Also:

Constant Field Values

STATUS_ABORTED

static final int STATUS_ABORTED

See Also:

Constant Field Values

STATUS_CLOSED

static final int STATUS_CLOSED

See Also:

Constant Field Values

Method Detail

getParticipant

IBPParticipant getParticipant()

toLaneArray

IBPLane[] toLaneArray()

toFlowElementArray

IModelElement[] toFlowElementArray()

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

setCategories

void setCategories(java.lang.String[] categories)

getCategories

java.lang.String[] getCategories()

addAssignment

void addAssignment(IBPAssignment assignment)

removeAssignment

void removeAssignment(IBPAssignment assignment)

getAssignmentByIndex

IBPAssignment getAssignmentByIndex(int index)

removeAssignmentByIndex

void removeAssignmentByIndex(int index)

assignmentCount

int assignmentCount()

assignmentIterator

java.util.Iterator assignmentIterator()

Returns an iterator over the model elements IBPAssignment.

toAssignmentArray

IBPAssignment[] toAssignmentArray()

setSuppressJoinFailure

void setSuppressJoinFailure(boolean suppressJoinFailure)

isSuppressJoinFailure

boolean isSuppressJoinFailure()

setEnableInstanceCompensation

void setEnableInstanceCompensation(boolean enableInstanceCompensation)

isEnableInstanceCompensation

boolean isEnableInstanceCompensation()

setClosed

void setClosed(boolean closed)

isClosed

boolean isClosed()

setMonitoring

void setMonitoring(IBPMonitoring monitoring)

getMonitoring

IBPMonitoring getMonitoring()

setAuditing

void setAuditing(IBPAuditing auditing)

getAuditing

IBPAuditing getAuditing()

addSupport

void addSupport(IBPProcess support)

removeSupport

void removeSupport(IBPProcess support)

getSupportByIndex

IBPProcess getSupportByIndex(int index)

removeSupportByIndex

void removeSupportByIndex(int index)

supportCount

int supportCount()

supportIterator

java.util.Iterator supportIterator()

Returns an iterator over the model elements IBPProcess.

toSupportArray

IBPProcess[] toSupportArray()

setProcessType

void setProcessType(int processType)

getProcessType

int getProcessType()

addProperty

void addProperty(IBPProperty property)

removeProperty

void removeProperty(IBPProperty property)

getPropertyByIndex

IBPProperty getPropertyByIndex(int index)

removePropertyByIndex

void removePropertyByIndex(int index)

propertyCount

int propertyCount()

propertyIterator

java.util.Iterator propertyIterator()

Returns an iterator over the model elements IBPProperty.

toPropertyArray

IBPProperty[] toPropertyArray()

setStatus

void setStatus(int status)

getStatus

int getStatus()