com.vp.plugin.model

Interface IRestResourceParameter

All Superinterfaces:

IModelElement, IModelElementParent

public interface IRestResourceParameter
extends IModelElement

Field Summary

Fields

Modifier and Type	Field and Description
static int	IN_FORM_DATA
static int	IN_HEADER
static int	IN_PATH
static int	IN_QUERY
static java.lang.String	PROP_DOCUMENTATION
static java.lang.String	PROP_ENUM
static java.lang.String	PROP_EXAMPLE
static java.lang.String	PROP_FORMAT
static java.lang.String	PROP_IN
static java.lang.String	PROP_REQUIRED
static java.lang.String	PROP_TAGGED_VALUES
static java.lang.String	PROP_TYPE
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[]	getEnum()
java.lang.String	getExample()
java.lang.String	getFormat()
java.lang.String	getHTMLDescription()
java.lang.String	getHTMLDescription(boolean convertPlainTextToHTML)
int	getIn()
ITaggedValueContainer	getTaggedValues()
IDataType	getType()
IVoice	getVoiceByIndex(int index)
boolean	isRequired()
void	removeVoice(IVoice voice)
void	removeVoiceByIndex(int index)
void	setDescription(java.lang.String description)
void	setEnum(java.lang.String[] $enum)
void	setExample(java.lang.String example)
void	setFormat(java.lang.String format)
void	setHTMLDescription(java.lang.String description)
void	setIn(int in)
void	setRequired(boolean required)
void	setTaggedValues(ITaggedValueContainer taggedValues)
void	setType(IDataType type)
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_EXAMPLE

static final java.lang.String PROP_EXAMPLE

See Also:

Constant Field Values

PROP_IN

static final java.lang.String PROP_IN

See Also:

Constant Field Values

IN_QUERY

static final int IN_QUERY

See Also:

Constant Field Values

IN_HEADER

static final int IN_HEADER

See Also:

Constant Field Values

IN_PATH

static final int IN_PATH

See Also:

Constant Field Values

IN_FORM_DATA

static final int IN_FORM_DATA

See Also:

Constant Field Values

PROP_REQUIRED

static final java.lang.String PROP_REQUIRED

See Also:

Constant Field Values

PROP_TYPE

static final java.lang.String PROP_TYPE

See Also:

Constant Field Values

PROP_FORMAT

static final java.lang.String PROP_FORMAT

See Also:

Constant Field Values

PROP_ENUM

static final java.lang.String PROP_ENUM

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

setExample

void setExample(java.lang.String example)

getExample

java.lang.String getExample()

setIn

void setIn(int in)

getIn

int getIn()

setRequired

void setRequired(boolean required)

isRequired

boolean isRequired()

setType

void setType(IDataType type)

getType

IDataType getType()

setFormat

void setFormat(java.lang.String format)

getFormat

java.lang.String getFormat()

setEnum

void setEnum(java.lang.String[] $enum)

getEnum

java.lang.String[] getEnum()