IBPMessage

All Superinterfaces:

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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_FROM`
`static java.lang.String`	`PROP_PARTS`
`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_STRUCTURE`
`static java.lang.String`	`PROP_TO`
`static java.lang.String`	`PROP_TYPE`
`static int`	`TYPE_INITIATING`
`static int`	`TYPE_RETURN`

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
Modifier and Type	Method and Description
`void`	`addPart(IBPELPart part)`
`void`	`addProperty(IBPProperty property)`
`int`	`fromRelationshipCount()` Number of `ISimpleRelationship` that connect from this model element.
`int`	`fromRelationshipEndCount()` Number of `IRelationshipEnd` that connect from this model element.
`java.util.Iterator`	`fromRelationshipEndIterator()` `IRelationshipEnd`s that connect from this model element.
`java.util.Iterator`	`fromRelationshipIterator()` `ISimpleRelationship`s that connect from this model element.
`IBPParticipant`	`getFrom()`
`IBPELPart`	`getPartByIndex(int index)`
`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
`IBPItemDefinition`	`getStructure()`
`IBPParticipant`	`getTo()`
`int`	`getType()`
`int`	`partCount()`
`java.util.Iterator`	`partIterator()` Returns an iterator over the model elements `IBPELPart`.
`int`	`propertyCount()`
`java.util.Iterator`	`propertyIterator()` Returns an iterator over the model elements `IBPProperty`.
`void`	`removePart(IBPELPart part)`
`void`	`removePartByIndex(int index)`
`void`	`removeProperty(IBPProperty property)`
`void`	`removePropertyByIndex(int index)`
`void`	`setFrom(IBPParticipant from)`
`void`	`setQualityReason(java.lang.String qualityReason)`
`void`	`setQualityScore(int qualityScore)`
`void`	`setStructure(IBPItemDefinition structure)`
`void`	`setTo(IBPParticipant to)`
`void`	`setType(int type)`
`ISimpleRelationship[]`	`toFromRelationshipArray()` `ISimpleRelationship`s that connect from this model element.
`IRelationshipEnd[]`	`toFromRelationshipEndArray()` `IRelationshipEnd`s that connect from this model element.
`IBPELPart[]`	`toPartArray()`
`IBPProperty[]`	`toPropertyArray()`
`int`	`toRelationshipCount()` Number of `ISimpleRelationship` that connect to this model element.
`int`	`toRelationshipEndCount()` Number of `IRelationshipEnd` that connect to this model element.
`java.util.Iterator`	`toRelationshipEndIterator()` `IRelationshipEnd`s that connect to this model element.
`java.util.Iterator`	`toRelationshipIterator()` `ISimpleRelationship`s that connect to this model element.
`ISimpleRelationship[]`	`toToRelationshipArray()` `ISimpleRelationship`s that connect to this model element.
`IRelationshipEnd[]`	`toToRelationshipEndArray()` `IRelationshipEnd`s that connect to this model element.

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, addStereotype, addStereotype, addSubDiagram, canModify, childCount, childCount, childCount, childIterator, childIterator, childIterator, constraintsIterator, createChild, delete, disposeTransientModel, duplicate, fromChartRelationshipCount, fromChartRelationshipIterator, 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, 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, toModelPropertyArray, toPropertiesString, toStereotypeModelArray, toSubDiagramArray, toToChartRelationshipArray

- Field Detail
  - 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_PARTS
```
static final java.lang.String PROP_PARTS
```
    See Also:
    
    Constant Field Values
  - PROP_PROPERTIES
```
static final java.lang.String PROP_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - PROP_FROM
```
static final java.lang.String PROP_FROM
```
    See Also:
    
    Constant Field Values
  - PROP_TO
```
static final java.lang.String PROP_TO
```
    See Also:
    
    Constant Field Values
  - PROP_STRUCTURE
```
static final java.lang.String PROP_STRUCTURE
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE
```
static final java.lang.String PROP_TYPE
```
    See Also:
    
    Constant Field Values
  - TYPE_INITIATING
```
static final int TYPE_INITIATING
```
    See Also:
    
    Constant Field Values
  - TYPE_RETURN
```
static final int TYPE_RETURN
```
    See Also:
    
    Constant Field Values
- Method Detail
  - fromRelationshipCount
```
int fromRelationshipCount()
```
    Number of ISimpleRelationship that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipCount in interface IModelElement
    
    Returns:
    
    Number of FROM simple relationships
  - toFromRelationshipArray
```
ISimpleRelationship[] toFromRelationshipArray()
```
    ISimpleRelationships that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toFromRelationshipArray in interface IModelElement
    
    Returns:
    
    ISimpleRelationships that connect from this model element
  - fromRelationshipIterator
```
java.util.Iterator fromRelationshipIterator()
```
    ISimpleRelationships that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipIterator in interface IModelElement
    
    Returns:
    
    ISimpleRelationships that connect from this model element
  - toRelationshipCount
```
int toRelationshipCount()
```
    Number of ISimpleRelationship that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipCount in interface IModelElement
    
    Returns:
    
    Number of TO simple relationships
  - toToRelationshipArray
```
ISimpleRelationship[] toToRelationshipArray()
```
    ISimpleRelationships that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toToRelationshipArray in interface IModelElement
    
    Returns:
    
    ISimpleRelationships that connect to this model element
  - toRelationshipIterator
```
java.util.Iterator toRelationshipIterator()
```
    ISimpleRelationships that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipIterator in interface IModelElement
    
    Returns:
    
    ISimpleRelationships that connect to this model element
  - fromRelationshipEndCount
```
int fromRelationshipEndCount()
```
    Number of IRelationshipEnd that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipEndCount in interface IModelElement
    
    Returns:
    
    Number of FROM relationship ends
  - toFromRelationshipEndArray
```
IRelationshipEnd[] toFromRelationshipEndArray()
```
    IRelationshipEnds that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toFromRelationshipEndArray in interface IModelElement
    
    Returns:
    
    IRelationshipEnds that connect from this model element
  - fromRelationshipEndIterator
```
java.util.Iterator fromRelationshipEndIterator()
```
    IRelationshipEnds that connect from this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    fromRelationshipEndIterator in interface IModelElement
    
    Returns:
    
    IRelationshipEnds that connect from this model element
  - toRelationshipEndCount
```
int toRelationshipEndCount()
```
    Number of IRelationshipEnd that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipEndCount in interface IModelElement
    
    Returns:
    
    Number of TO relationship ends
  - toToRelationshipEndArray
```
IRelationshipEnd[] toToRelationshipEndArray()
```
    IRelationshipEnds that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toToRelationshipEndArray in interface IModelElement
    
    Returns:
    
    IRelationshipEnds that connect to this model element
  - toRelationshipEndIterator
```
java.util.Iterator toRelationshipEndIterator()
```
    IRelationshipEnds that connect to this model element. Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445
    
    Specified by:
    
    toRelationshipEndIterator in interface IModelElement
    
    Returns:
    
    IRelationshipEnds that connect to this model element
  - 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
  - addPart
```
void addPart(IBPELPart part)
```
  - removePart
```
void removePart(IBPELPart part)
```
  - getPartByIndex
```
IBPELPart getPartByIndex(int index)
```
  - removePartByIndex
```
void removePartByIndex(int index)
```
  - partCount
```
int partCount()
```
  - partIterator
```
java.util.Iterator partIterator()
```
    Returns an iterator over the model elements IBPELPart.
  - toPartArray
```
IBPELPart[] toPartArray()
```
  - 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()
```
  - setFrom
```
void setFrom(IBPParticipant from)
```
  - getFrom
```
IBPParticipant getFrom()
```
  - setTo
```
void setTo(IBPParticipant to)
```
  - getTo
```
IBPParticipant getTo()
```
  - setStructure
```
void setStructure(IBPItemDefinition structure)
```
  - getStructure
```
IBPItemDefinition getStructure()
```
  - setType
```
void setType(int type)
```
  - getType
```
int getType()
```

Interface IBPMessage

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_QUALITY_SCORE

PROP_QUALITY_REASON

PROP_PARTS

PROP_PROPERTIES

PROP_FROM

PROP_TO

PROP_STRUCTURE

PROP_TYPE

TYPE_INITIATING

TYPE_RETURN

Method Detail

fromRelationshipCount

toFromRelationshipArray

fromRelationshipIterator

toRelationshipCount

toToRelationshipArray

toRelationshipIterator

fromRelationshipEndCount

toFromRelationshipEndArray

fromRelationshipEndIterator

toRelationshipEndCount

toToRelationshipEndArray

toRelationshipEndIterator

setQualityScore

getQualityScore

setQualityReason

getQualityReason

addPart

removePart

getPartByIndex

removePartByIndex

partCount

partIterator

toPartArray

addProperty

removeProperty

getPropertyByIndex

removePropertyByIndex

propertyCount

propertyIterator

toPropertyArray

setFrom

getFrom

setTo

getTo

setStructure

getStructure

setType

getType