com.vp.plugin.model

Interface IApiTag

All Superinterfaces:

IModelElement, IModelElementParent

public interface IApiTag
extends IModelElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_DOCUMENTATION
static java.lang.String	PROP_EXTERNAL_DOCS_DESCRIPTION
static java.lang.String	PROP_EXTERNAL_DOCS_URL
static java.lang.String	PROP_TAGGED_VALUES
static java.lang.String	PROP_VOICES

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

Methods

Modifier and Type	Method and Description
void	addVoice(IVoice voice)
java.lang.String	getDescription()
java.lang.String	getExternalDocsDescription()
java.lang.String	getExternalDocsUrl()
java.lang.String	getHTMLDescription()
java.lang.String	getHTMLDescription(boolean convertPlainTextToHTML)
java.lang.String	getHTMLExternalDocsDescription()
java.lang.String	getHTMLExternalDocsDescription(boolean convertPlainTextToHTML)
ITaggedValueContainer	getTaggedValues()
IVoice	getVoiceByIndex(int index)
void	removeVoice(IVoice voice)
void	removeVoiceByIndex(int index)
void	setDescription(java.lang.String description)
void	setExternalDocsDescription(java.lang.String externalDocsDescription)
void	setExternalDocsUrl(java.lang.String externalDocsUrl)
void	setHTMLDescription(java.lang.String description)
void	setHTMLExternalDocsDescription(java.lang.String externalDocsDescription)
void	setTaggedValues(ITaggedValueContainer taggedValues)
IVoice[]	toVoiceArray()
int	voiceCount()
java.util.Iterator	voiceIterator() Returns an iterator over the model elements IVoice.

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, hasStereotype, indexOfSubDiagram, isMirrorModelElement, isTransientModel, removeChild, removeChildByIndex, removePropertyChangeListener, removeStereotype, removeStereotype, removeSubDiagram, setDocumentation, setHTMLDocumentation, setName, setNickDescription, setNickDocumentation, setNickHTMLDescription, setNickHTMLDocumentation, setNickname, 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_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_TAGGED_VALUES

static final java.lang.String PROP_TAGGED_VALUES

See Also:

Constant Field Values

PROP_EXTERNAL_DOCS_DESCRIPTION

static final java.lang.String PROP_EXTERNAL_DOCS_DESCRIPTION

See Also:

Constant Field Values

PROP_EXTERNAL_DOCS_URL

static final java.lang.String PROP_EXTERNAL_DOCS_URL

See Also:

Constant Field Values

Method Detail

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

setTaggedValues

void setTaggedValues(ITaggedValueContainer taggedValues)

Specified by:

setTaggedValues in interface IModelElement

getTaggedValues

ITaggedValueContainer getTaggedValues()

Specified by:

getTaggedValues in interface IModelElement

setExternalDocsDescription

void setExternalDocsDescription(java.lang.String externalDocsDescription)

getExternalDocsDescription

java.lang.String getExternalDocsDescription()

setHTMLExternalDocsDescription

void setHTMLExternalDocsDescription(java.lang.String externalDocsDescription)

getHTMLExternalDocsDescription

java.lang.String getHTMLExternalDocsDescription()

getHTMLExternalDocsDescription

java.lang.String getHTMLExternalDocsDescription(boolean convertPlainTextToHTML)

setExternalDocsUrl

void setExternalDocsUrl(java.lang.String externalDocsUrl)

getExternalDocsUrl

java.lang.String getExternalDocsUrl()