com.vp.plugin.model

Interface IUserStory

All Superinterfaces:

IHasChildrenBaseModelElement, IModelElement, IModelElementParent

public interface IUserStory
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_QUALITY_REASON
static java.lang.String	PROP_QUALITY_SCORE
static java.lang.String	PROP_REFERENCED_BY_DIAGRAM_IDS
static java.lang.String	PROP_REFERENCED_BY_MODEL_ADDRESSES
static java.lang.String	PROP_SCENARIOS
static java.lang.String	PROP_STEREOTYPES
static java.lang.String	PROP_SYNC_MAPPING_MODELS
static java.lang.String	PROP_TAGGED_VALUES
static java.lang.String	PROP_UX_REFERENCES

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_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) Deprecated.
void	addScenario(IStepContainer scenario) Deprecated.
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) Deprecated.
void	addUserStoryConfirmation(IUserStoryConfirmation child) Deprecated.
void	addUserStoryConversation(IUserStoryConversation child) Deprecated.
void	addUxReference(IUxReference uxReference) Deprecated.
void	addWFScenario(IWFScenario child) Deprecated.
int	analysisItemModelCount()
java.util.Iterator	analysisItemModelIterator() Returns an iterator over the model elements IModelElement.
void	createUserStoryConfirmation() Deprecated.
void	createUserStoryConversation() Deprecated.
void	createWFScenario() Deprecated.
void	delete() Deprecated.
java.lang.String[]	getAnalysisItemDiagramIds()
IModelElement	getAnalysisItemModelByIndex(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
java.lang.String[]	getReferencedByDiagramIds()
java.lang.String[]	getReferencedByModelAddresses()
IStepContainer	getScenarioByIndex(int index)
IModelElement	getSyncMappingModelByIndex(int index)
ITaggedValueContainer	getTaggedValues()
IUserStoryConfirmation	getUserStoryConfirmationByIndex(int index)
IUserStoryConfirmation	getUserStoryConfirmationByName(java.lang.String name)
IUserStoryConversation	getUserStoryConversationByIndex(int index)
IUserStoryConversation	getUserStoryConversationByName(java.lang.String name)
ITaggedValue[]	getUserStoryTaggedValues()
IUxReference	getUxReferenceByIndex(int index)
IWFScenario	getWFScenarioByIndex(int index)
IWFScenario	getWFScenarioByName(java.lang.String name)
boolean	hasStereotype(java.lang.String name)
boolean	hasStereotypes(java.lang.String name) Deprecated. Replaced by hasStereotype
void	removeAnalysisItemModel(IModelElement analysisItemModel) Deprecated.
void	removeAnalysisItemModelByIndex(int index)
void	removeScenario(IStepContainer scenario) Deprecated.
void	removeScenarioByIndex(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) Deprecated.
void	removeSyncMappingModelByIndex(int index)
void	removeUserStoryConfirmation(IUserStoryConfirmation child) Deprecated.
void	removeUserStoryConfirmationByIndex(int index) Deprecated.
void	removeUserStoryConversation(IUserStoryConversation child) Deprecated.
void	removeUserStoryConversationByIndex(int index) Deprecated.
void	removeUxReference(IUxReference uxReference) Deprecated.
void	removeUxReferenceByIndex(int index)
void	removeWFScenario(IWFScenario child) Deprecated.
void	removeWFScenarioByIndex(int index) Deprecated.
void	reorderUserStoryConfirmation(IUserStoryConfirmation[] childs) Deprecated.
void	reorderUserStoryConversation(IUserStoryConversation[] childs) Deprecated.
void	reorderWFScenario(IWFScenario[] childs) Deprecated.
int	scenarioCount()
java.util.Iterator	scenarioIterator() Returns an iterator over the model elements IStepContainer.
void	setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds) Deprecated.
void	setName(java.lang.String name) Deprecated.
void	setQualityReason(java.lang.String qualityReason) Deprecated.
void	setQualityScore(int qualityScore) Deprecated.
void	setReferencedByDiagramIds(java.lang.String[] referencedByDiagramIds) Deprecated.
void	setReferencedByModelAddresses(java.lang.String[] referencedByModelAddresses) Deprecated.
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()
IStepContainer[]	toScenarioArray()
java.lang.String[]	toStereotypeArray()
IStereotype[]	toStereotypeModelArray()
java.lang.String[]	toStereotypesArray() Deprecated. Replaced by toStereotypeArray
IStereotype[]	toStereotypesModelArray() Deprecated. Replaced by toStereotypeModelArray
IModelElement[]	toSyncMappingModelArray()
IUserStoryConfirmation[]	toUserStoryConfirmationArray()
IUserStoryConversation[]	toUserStoryConversationArray()
IUxReference[]	toUxReferenceArray()
IWFScenario[]	toWFScenarioArray()
int	userStoryConfirmationCount()
java.util.Iterator	userStoryConfirmationIterator()
int	userStoryConversationCount()
java.util.Iterator	userStoryConversationIterator()
int	uxReferenceCount()
java.util.Iterator	uxReferenceIterator() Returns an iterator over the model elements IUxReference.
int	wFScenarioCount()
java.util.Iterator	wFScenarioIterator()

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

static final java.lang.String PROP_UX_REFERENCES

See Also:

Constant Field Values

PROP_SCENARIOS

static final java.lang.String PROP_SCENARIOS

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

Method Detail

addWFScenario

@Deprecated
void addWFScenario(IWFScenario child)

Deprecated.

UserStory is read-only.

removeWFScenario

@Deprecated
void removeWFScenario(IWFScenario child)

Deprecated.

UserStory is read-only.

getWFScenarioByIndex

IWFScenario getWFScenarioByIndex(int index)

removeWFScenarioByIndex

@Deprecated
void removeWFScenarioByIndex(int index)

Deprecated.

UserStory is read-only.

reorderWFScenario

@Deprecated
void reorderWFScenario(IWFScenario[] childs)

Deprecated.

UserStory is read-only.

wFScenarioCount

int wFScenarioCount()

wFScenarioIterator

java.util.Iterator wFScenarioIterator()

toWFScenarioArray

IWFScenario[] toWFScenarioArray()

createWFScenario

@Deprecated
void createWFScenario()

Deprecated.

UserStory is read-only.

getWFScenarioByName

IWFScenario getWFScenarioByName(java.lang.String name)

addUserStoryConversation

@Deprecated
void addUserStoryConversation(IUserStoryConversation child)

Deprecated.

UserStory is read-only.

removeUserStoryConversation

@Deprecated
void removeUserStoryConversation(IUserStoryConversation child)

Deprecated.

UserStory is read-only.

getUserStoryConversationByIndex

IUserStoryConversation getUserStoryConversationByIndex(int index)

removeUserStoryConversationByIndex

@Deprecated
void removeUserStoryConversationByIndex(int index)

Deprecated.

UserStory is read-only.

reorderUserStoryConversation

@Deprecated
void reorderUserStoryConversation(IUserStoryConversation[] childs)

Deprecated.

UserStory is read-only.

userStoryConversationCount

int userStoryConversationCount()

userStoryConversationIterator

java.util.Iterator userStoryConversationIterator()

toUserStoryConversationArray

IUserStoryConversation[] toUserStoryConversationArray()

createUserStoryConversation

@Deprecated
void createUserStoryConversation()

Deprecated.

UserStory is read-only.

getUserStoryConversationByName

IUserStoryConversation getUserStoryConversationByName(java.lang.String name)

addUserStoryConfirmation

@Deprecated
void addUserStoryConfirmation(IUserStoryConfirmation child)

Deprecated.

UserStory is read-only.

removeUserStoryConfirmation

@Deprecated
void removeUserStoryConfirmation(IUserStoryConfirmation child)

Deprecated.

UserStory is read-only.

getUserStoryConfirmationByIndex

IUserStoryConfirmation getUserStoryConfirmationByIndex(int index)

removeUserStoryConfirmationByIndex

@Deprecated
void removeUserStoryConfirmationByIndex(int index)

Deprecated.

UserStory is read-only.

reorderUserStoryConfirmation

@Deprecated
void reorderUserStoryConfirmation(IUserStoryConfirmation[] childs)

Deprecated.

UserStory is read-only.

userStoryConfirmationCount

int userStoryConfirmationCount()

userStoryConfirmationIterator

java.util.Iterator userStoryConfirmationIterator()

toUserStoryConfirmationArray

IUserStoryConfirmation[] toUserStoryConfirmationArray()

createUserStoryConfirmation

@Deprecated
void createUserStoryConfirmation()

Deprecated.

UserStory is read-only.

getUserStoryConfirmationByName

IUserStoryConfirmation getUserStoryConfirmationByName(java.lang.String name)

setName

@Deprecated
void setName(java.lang.String name)

Deprecated.

Description copied from interface: IModelElement

Set the name of this IModelElement.

Specified by:

setName in interface IModelElement

delete

@Deprecated
void delete()

Deprecated.

Specified by:

delete in interface IModelElement

getUserStoryTaggedValues

ITaggedValue[] getUserStoryTaggedValues()

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

@Deprecated
void addSyncMappingModel(IModelElement syncMappingModel)

Deprecated.

UserStory is read-only.

removeSyncMappingModel

@Deprecated
void removeSyncMappingModel(IModelElement syncMappingModel)

Deprecated.

UserStory is read-only.

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

@Deprecated
void addAnalysisItemModel(IModelElement analysisItemModel)

Deprecated.

UserStory is read-only.

removeAnalysisItemModel

@Deprecated
void removeAnalysisItemModel(IModelElement analysisItemModel)

Deprecated.

UserStory is read-only.

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

@Deprecated
void setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)

Deprecated.

UserStory is read-only.

getAnalysisItemDiagramIds

java.lang.String[] getAnalysisItemDiagramIds()

setQualityScore

@Deprecated
void setQualityScore(int qualityScore)

Deprecated.

UserStory is read-only.

getQualityScore

int getQualityScore()

Description copied from interface: IModelElement

Quality score, it is non-readable value for human

Specified by:

getQualityScore in interface IModelElement

setQualityReason

@Deprecated
void setQualityReason(java.lang.String qualityReason)

Deprecated.

UserStory is read-only.

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

addUxReference

@Deprecated
void addUxReference(IUxReference uxReference)

Deprecated.

UserStory is read-only.

removeUxReference

@Deprecated
void removeUxReference(IUxReference uxReference)

Deprecated.

UserStory is read-only.

getUxReferenceByIndex

IUxReference getUxReferenceByIndex(int index)

removeUxReferenceByIndex

void removeUxReferenceByIndex(int index)

uxReferenceCount

int uxReferenceCount()

uxReferenceIterator

java.util.Iterator uxReferenceIterator()

Returns an iterator over the model elements IUxReference.

toUxReferenceArray

IUxReference[] toUxReferenceArray()

addScenario

@Deprecated
void addScenario(IStepContainer scenario)

Deprecated.

UserStory is read-only.

removeScenario

@Deprecated
void removeScenario(IStepContainer scenario)

Deprecated.

UserStory is read-only.

getScenarioByIndex

IStepContainer getScenarioByIndex(int index)

removeScenarioByIndex

void removeScenarioByIndex(int index)

scenarioCount

int scenarioCount()

scenarioIterator

java.util.Iterator scenarioIterator()

Returns an iterator over the model elements IStepContainer.

toScenarioArray

IStepContainer[] toScenarioArray()

setReferencedByDiagramIds

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

Deprecated.

UserStory is read-only.

Specified by:

setReferencedByDiagramIds in interface IHasChildrenBaseModelElement

getReferencedByDiagramIds

java.lang.String[] getReferencedByDiagramIds()

Specified by:

getReferencedByDiagramIds in interface IHasChildrenBaseModelElement

setReferencedByModelAddresses

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

Deprecated.

UserStory is read-only.

Specified by:

setReferencedByModelAddresses in interface IHasChildrenBaseModelElement

getReferencedByModelAddresses

java.lang.String[] getReferencedByModelAddresses()

Specified by:

getReferencedByModelAddresses in interface IHasChildrenBaseModelElement