IWFDState

All Superinterfaces:

IModelElement, IModelElementParent
```
public interface IWFDState
extends IModelElement
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_DIAGRAM_ID`
`static java.lang.String`	`PROP_DOCUMENTATION`
`static java.lang.String`	`PROP_ELEMENT_PROFILES`
`static java.lang.String`	`PROP_ELEMENTS`
`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_STATE_SCENARIOS`
`static java.lang.String`	`PROP_STATE_STEP_EXTENSIONS`
`static java.lang.String`	`PROP_VOICES`
`static java.lang.String`	`PROP_WIREFLOW_NODES`

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
Modifier and Type	Method and Description
`void`	`addElement(IModelElement element)`
`void`	`addElementProfile(IModelElement elementProfile)`
`void`	`addReference(IReference reference)`
`void`	`addStateScenario(IWFDStateScenario stateScenario)`
`void`	`addStateStepExtension(IWFDStateStepExtension stateStepExtension)`
`void`	`addVoice(IVoice voice)`
`void`	`addWFDState(IWFDState child)`
`void`	`addWireflowNode(IWireflowNode wireflowNode)`
`IWFDState`	`createWFDState()`
`int`	`elementCount()`
`java.util.Iterator`	`elementIterator()` Returns an iterator over the model elements `IModelElement`.
`int`	`elementProfileCount()`
`java.util.Iterator`	`elementProfileIterator()` Returns an iterator over the model elements `IModelElement`.
`java.lang.String`	`getDescription()`
`java.lang.String`	`getDiagramId()`
`IModelElement`	`getElementByIndex(int index)`
`IModelElement`	`getElementProfileByIndex(int index)`
`java.lang.String`	`getHTMLDescription()`
`java.lang.String`	`getHTMLDescription(boolean convertPlainTextToHTML)`
`IReference`	`getReferenceByIndex(int index)`
`java.lang.String[]`	`getReferencedByDiagramIds()`
`java.lang.String[]`	`getReferencedByModelAddresses()`
`IWFDStateScenario`	`getStateScenarioByIndex(int index)`
`IWFDStateStepExtension`	`getStateStepExtensionByIndex(int index)`
`IVoice`	`getVoiceByIndex(int index)`
`IWFDState`	`getWFDStateByIndex(int index)`
`IWFDState`	`getWFDStateByName(java.lang.String name)`
`IWireflowNode`	`getWireflowNodeByIndex(int index)`
`int`	`referenceCount()`
`java.util.Iterator`	`referenceIterator()` Returns an iterator over the model elements `IReference`.
`void`	`removeElement(IModelElement element)`
`void`	`removeElementByIndex(int index)`
`void`	`removeElementProfile(IModelElement elementProfile)`
`void`	`removeElementProfileByIndex(int index)`
`void`	`removeReference(IReference reference)`
`void`	`removeReferenceByIndex(int index)`
`void`	`removeStateScenario(IWFDStateScenario stateScenario)`
`void`	`removeStateScenarioByIndex(int index)`
`void`	`removeStateStepExtension(IWFDStateStepExtension stateStepExtension)`
`void`	`removeStateStepExtensionByIndex(int index)`
`void`	`removeVoice(IVoice voice)`
`void`	`removeVoiceByIndex(int index)`
`void`	`removeWFDState(IWFDState child)`
`void`	`removeWFDStateByIndex(int index)`
`void`	`removeWireflowNode(IWireflowNode wireflowNode)`
`void`	`removeWireflowNodeByIndex(int index)`
`void`	`reorderWFDState(IWFDState[] childs)`
`void`	`setDescription(java.lang.String description)`
`void`	`setDiagramId(java.lang.String diagramId)`
`void`	`setHTMLDescription(java.lang.String description)`
`void`	`setReferencedByDiagramIds(java.lang.String[] referencedByDiagramIds)`
`void`	`setReferencedByModelAddresses(java.lang.String[] referencedByModelAddresses)`
`int`	`stateScenarioCount()`
`java.util.Iterator`	`stateScenarioIterator()` Returns an iterator over the model elements `IWFDStateScenario`.
`int`	`stateStepExtensionCount()`
`java.util.Iterator`	`stateStepExtensionIterator()` Returns an iterator over the model elements `IWFDStateStepExtension`.
`IModelElement[]`	`toElementArray()`
`IModelElement[]`	`toElementProfileArray()`
`IReference[]`	`toReferenceArray()`
`IWFDStateScenario[]`	`toStateScenarioArray()`
`IWFDStateStepExtension[]`	`toStateStepExtensionArray()`
`IVoice[]`	`toVoiceArray()`
`IWFDState[]`	`toWFDStateArray()`
`IWireflowNode[]`	`toWireflowNodeArray()`
`int`	`voiceCount()`
`java.util.Iterator`	`voiceIterator()` Returns an iterator over the model elements `IVoice`.
`int`	`wFDStateCount()`
`java.util.Iterator`	`wFDStateIterator()`
`int`	`wireflowNodeCount()`
`java.util.Iterator`	`wireflowNodeIterator()` Returns an iterator over the model elements `IWireflowNode`.

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_DIAGRAM_ID
```
static final java.lang.String PROP_DIAGRAM_ID
```
  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_ELEMENTS
```
static final java.lang.String PROP_ELEMENTS
```
  See Also:
  
  Constant Field Values
- PROP_ELEMENT_PROFILES
```
static final java.lang.String PROP_ELEMENT_PROFILES
```
  See Also:
  
  Constant Field Values
- PROP_STATE_STEP_EXTENSIONS
```
static final java.lang.String PROP_STATE_STEP_EXTENSIONS
```
  See Also:
  
  Constant Field Values
- PROP_STATE_SCENARIOS
```
static final java.lang.String PROP_STATE_SCENARIOS
```
  See Also:
  
  Constant Field Values
- PROP_WIREFLOW_NODES
```
static final java.lang.String PROP_WIREFLOW_NODES
```
  See Also:
  
  Constant Field Values

Method Detail

addWFDState
```
void addWFDState(IWFDState child)
```

removeWFDState
```
void removeWFDState(IWFDState child)
```

getWFDStateByIndex

IWFDState getWFDStateByIndex(int index)

removeWFDStateByIndex
```
void removeWFDStateByIndex(int index)
```

reorderWFDState

void reorderWFDState(IWFDState[] childs)

wFDStateCount
```
int wFDStateCount()
```

wFDStateIterator
```
java.util.Iterator wFDStateIterator()
```

toWFDStateArray
```
IWFDState[] toWFDStateArray()
```

createWFDState
```
IWFDState createWFDState()
```

getWFDStateByName

IWFDState getWFDStateByName(java.lang.String name)

setDiagramId

void setDiagramId(java.lang.String diagramId)

getDiagramId
```
java.lang.String getDiagramId()
```

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()

addElement

void addElement(IModelElement element)

removeElement

void removeElement(IModelElement element)

getElementByIndex

IModelElement getElementByIndex(int index)

removeElementByIndex
```
void removeElementByIndex(int index)
```

elementCount
```
int elementCount()
```

elementIterator
```
java.util.Iterator elementIterator()
```
Returns an iterator over the model elements IModelElement.

toElementArray
```
IModelElement[] toElementArray()
```

addElementProfile

void addElementProfile(IModelElement elementProfile)

removeElementProfile

void removeElementProfile(IModelElement elementProfile)

getElementProfileByIndex

IModelElement getElementProfileByIndex(int index)

removeElementProfileByIndex

void removeElementProfileByIndex(int index)

elementProfileCount
```
int elementProfileCount()
```

elementProfileIterator
```
java.util.Iterator elementProfileIterator()
```
Returns an iterator over the model elements IModelElement.

toElementProfileArray

IModelElement[] toElementProfileArray()

addStateStepExtension

void addStateStepExtension(IWFDStateStepExtension stateStepExtension)

removeStateStepExtension

void removeStateStepExtension(IWFDStateStepExtension stateStepExtension)

getStateStepExtensionByIndex

IWFDStateStepExtension getStateStepExtensionByIndex(int index)

removeStateStepExtensionByIndex

void removeStateStepExtensionByIndex(int index)

stateStepExtensionCount
```
int stateStepExtensionCount()
```

stateStepExtensionIterator
```
java.util.Iterator stateStepExtensionIterator()
```
Returns an iterator over the model elements IWFDStateStepExtension.

toStateStepExtensionArray

IWFDStateStepExtension[] toStateStepExtensionArray()

addStateScenario

void addStateScenario(IWFDStateScenario stateScenario)

removeStateScenario

void removeStateScenario(IWFDStateScenario stateScenario)

getStateScenarioByIndex

IWFDStateScenario getStateScenarioByIndex(int index)

removeStateScenarioByIndex

void removeStateScenarioByIndex(int index)

stateScenarioCount
```
int stateScenarioCount()
```

stateScenarioIterator
```
java.util.Iterator stateScenarioIterator()
```
Returns an iterator over the model elements IWFDStateScenario.

toStateScenarioArray

IWFDStateScenario[] toStateScenarioArray()

addWireflowNode

void addWireflowNode(IWireflowNode wireflowNode)

removeWireflowNode

void removeWireflowNode(IWireflowNode wireflowNode)

getWireflowNodeByIndex

IWireflowNode getWireflowNodeByIndex(int index)

removeWireflowNodeByIndex

void removeWireflowNodeByIndex(int index)

wireflowNodeCount
```
int wireflowNodeCount()
```

wireflowNodeIterator
```
java.util.Iterator wireflowNodeIterator()
```
Returns an iterator over the model elements IWireflowNode.

toWireflowNodeArray
```
IWireflowNode[] toWireflowNodeArray()
```

Interface IWFDState

Field Summary

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

Method Summary

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

Field Detail

PROP_DIAGRAM_ID

PROP_DOCUMENTATION

PROP_VOICES

PROP_REFERENCES

PROP_REFERENCED_BY_DIAGRAM_IDS

PROP_REFERENCED_BY_MODEL_ADDRESSES

PROP_ELEMENTS

PROP_ELEMENT_PROFILES

PROP_STATE_STEP_EXTENSIONS

PROP_STATE_SCENARIOS

PROP_WIREFLOW_NODES

Method Detail

addWFDState

removeWFDState

getWFDStateByIndex

removeWFDStateByIndex

reorderWFDState

wFDStateCount

wFDStateIterator

toWFDStateArray

createWFDState

getWFDStateByName

setDiagramId

getDiagramId

setDescription

getDescription

setHTMLDescription

getHTMLDescription

getHTMLDescription

addVoice

removeVoice

getVoiceByIndex

removeVoiceByIndex

voiceCount

voiceIterator

toVoiceArray

addReference

removeReference

getReferenceByIndex

removeReferenceByIndex

referenceCount

referenceIterator

toReferenceArray

setReferencedByDiagramIds

getReferencedByDiagramIds

setReferencedByModelAddresses

getReferencedByModelAddresses

addElement

removeElement

getElementByIndex

removeElementByIndex

elementCount

elementIterator

toElementArray

addElementProfile

removeElementProfile

getElementProfileByIndex

removeElementProfileByIndex

elementProfileCount

elementProfileIterator

toElementProfileArray

addStateStepExtension

removeStateStepExtension

getStateStepExtensionByIndex

removeStateStepExtensionByIndex

stateStepExtensionCount

stateStepExtensionIterator

toStateStepExtensionArray

addStateScenario

removeStateScenario

getStateScenarioByIndex

removeStateScenarioByIndex

stateScenarioCount

stateScenarioIterator