com.vp.plugin.model

Interface IApiProfile

All Superinterfaces:

IModelElement, IModelElementParent

public interface IApiProfile
extends IModelElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_BASE_PATH
static java.lang.String	PROP_CONTACT_EMAIL
static java.lang.String	PROP_CONTACT_NAME
static java.lang.String	PROP_CONTACT_URL
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_HOST
static java.lang.String	PROP_LICENSE_NAME
static java.lang.String	PROP_LICENSE_URL
static java.lang.String	PROP_SCHEMES
static java.lang.String	PROP_TAGGED_VALUES
static java.lang.String	PROP_TAGS
static java.lang.String	PROP_TERMS_OF_SERVICE
static java.lang.String	PROP_TITLE
static java.lang.String	PROP_VERSION
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

Modifier and Type	Method and Description
void	addTag(IApiTag tag)
void	addVoice(IVoice voice)
java.lang.String	getBasePath()
java.lang.String	getContactEmail()
java.lang.String	getContactName()
java.lang.String	getContactUrl()
java.lang.String	getDescription()
java.lang.String	getExternalDocsDescription()
java.lang.String	getExternalDocsUrl()
java.lang.String	getHost()
java.lang.String	getHTMLDescription()
java.lang.String	getHTMLDescription(boolean convertPlainTextToHTML)
java.lang.String	getHTMLExternalDocsDescription()
java.lang.String	getHTMLExternalDocsDescription(boolean convertPlainTextToHTML)
java.lang.String	getLicenseName()
java.lang.String	getLicenseUrl()
java.lang.String[]	getSchemes()
IApiTag	getTagByIndex(int index)
ITaggedValueContainer	getTaggedValues()
java.lang.String	getTermsOfService()
java.lang.String	getTitle()
java.lang.String	getVersion()
IVoice	getVoiceByIndex(int index)
void	removeTag(IApiTag tag)
void	removeTagByIndex(int index)
void	removeVoice(IVoice voice)
void	removeVoiceByIndex(int index)
void	setBasePath(java.lang.String basePath)
void	setContactEmail(java.lang.String contactEmail)
void	setContactName(java.lang.String contactName)
void	setContactUrl(java.lang.String contactUrl)
void	setDescription(java.lang.String description)
void	setExternalDocsDescription(java.lang.String externalDocsDescription)
void	setExternalDocsUrl(java.lang.String externalDocsUrl)
void	setHost(java.lang.String host)
void	setHTMLDescription(java.lang.String description)
void	setHTMLExternalDocsDescription(java.lang.String externalDocsDescription)
void	setLicenseName(java.lang.String licenseName)
void	setLicenseUrl(java.lang.String licenseUrl)
void	setSchemes(java.lang.String[] schemes)
void	setTaggedValues(ITaggedValueContainer taggedValues)
void	setTermsOfService(java.lang.String termsOfService)
void	setTitle(java.lang.String title)
void	setVersion(java.lang.String version)
int	tagCount()
java.util.Iterator	tagIterator() Returns an iterator over the model elements IApiTag.
IApiTag[]	toTagArray()
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_VERSION

static final java.lang.String PROP_VERSION

See Also:

Constant Field Values

PROP_TITLE

static final java.lang.String PROP_TITLE

See Also:

Constant Field Values

PROP_TERMS_OF_SERVICE

static final java.lang.String PROP_TERMS_OF_SERVICE

See Also:

Constant Field Values

PROP_CONTACT_NAME

static final java.lang.String PROP_CONTACT_NAME

See Also:

Constant Field Values

PROP_CONTACT_URL

static final java.lang.String PROP_CONTACT_URL

See Also:

Constant Field Values

PROP_CONTACT_EMAIL

static final java.lang.String PROP_CONTACT_EMAIL

See Also:

Constant Field Values

PROP_LICENSE_NAME

static final java.lang.String PROP_LICENSE_NAME

See Also:

Constant Field Values

PROP_LICENSE_URL

static final java.lang.String PROP_LICENSE_URL

See Also:

Constant Field Values

PROP_HOST

static final java.lang.String PROP_HOST

See Also:

Constant Field Values

PROP_BASE_PATH

static final java.lang.String PROP_BASE_PATH

See Also:

Constant Field Values

PROP_SCHEMES

static final java.lang.String PROP_SCHEMES

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

PROP_TAGS

static final java.lang.String PROP_TAGS

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

setVersion

void setVersion(java.lang.String version)

getVersion

java.lang.String getVersion()

setTitle

void setTitle(java.lang.String title)

getTitle

java.lang.String getTitle()

setTermsOfService

void setTermsOfService(java.lang.String termsOfService)

getTermsOfService

java.lang.String getTermsOfService()

setContactName

void setContactName(java.lang.String contactName)

getContactName

java.lang.String getContactName()

setContactUrl

void setContactUrl(java.lang.String contactUrl)

getContactUrl

java.lang.String getContactUrl()

setContactEmail

void setContactEmail(java.lang.String contactEmail)

getContactEmail

java.lang.String getContactEmail()

setLicenseName

void setLicenseName(java.lang.String licenseName)

getLicenseName

java.lang.String getLicenseName()

setLicenseUrl

void setLicenseUrl(java.lang.String licenseUrl)

getLicenseUrl

java.lang.String getLicenseUrl()

setHost

void setHost(java.lang.String host)

getHost

java.lang.String getHost()

setBasePath

void setBasePath(java.lang.String basePath)

getBasePath

java.lang.String getBasePath()

setSchemes

void setSchemes(java.lang.String[] schemes)

getSchemes

java.lang.String[] getSchemes()

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

addTag

void addTag(IApiTag tag)

removeTag

void removeTag(IApiTag tag)

getTagByIndex

IApiTag getTagByIndex(int index)

removeTagByIndex

void removeTagByIndex(int index)

tagCount

int tagCount()

tagIterator

java.util.Iterator tagIterator()

Returns an iterator over the model elements IApiTag.

toTagArray

IApiTag[] toTagArray()