com.vp.plugin.model

Interface IRestResourceRequestBody

All Superinterfaces:

IModelElement, IModelElementParent

public interface IRestResourceRequestBody
extends IModelElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_DOCUMENTATION
static java.lang.String	PROP_EXAMPLE
static java.lang.String	PROP_HEADER
static java.lang.String	PROP_REQUIRED
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)
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() IRelationshipEnds that connect from this model element.
java.util.Iterator	fromRelationshipIterator() ISimpleRelationships that connect from this model element.
java.lang.String	getDescription()
java.lang.String	getExample()
java.lang.String	getHeader()
java.lang.String	getHTMLDescription()
java.lang.String	getHTMLDescription(boolean convertPlainTextToHTML)
ITaggedValueContainer	getTaggedValues()
IVoice	getVoiceByIndex(int index)
boolean	isRequired()
void	removeVoice(IVoice voice)
void	removeVoiceByIndex(int index)
void	setDescription(java.lang.String description)
void	setExample(java.lang.String example)
void	setHeader(java.lang.String header)
void	setHTMLDescription(java.lang.String description)
void	setRequired(boolean required)
void	setTaggedValues(ITaggedValueContainer taggedValues)
ISimpleRelationship[]	toFromRelationshipArray() ISimpleRelationships that connect from this model element.
IRelationshipEnd[]	toFromRelationshipEndArray() IRelationshipEnds that connect from this model element.
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() IRelationshipEnds that connect to this model element.
java.util.Iterator	toRelationshipIterator() ISimpleRelationships that connect to this model element.
ISimpleRelationship[]	toToRelationshipArray() ISimpleRelationships that connect to this model element.
IRelationshipEnd[]	toToRelationshipEndArray() IRelationshipEnds that connect to this model element.
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, 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, toModelPropertyArray, toPropertiesString, toStereotypeModelArray, toSubDiagramArray, toToChartRelationshipArray

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_HEADER

static final java.lang.String PROP_HEADER

See Also:

Constant Field Values

PROP_EXAMPLE

static final java.lang.String PROP_EXAMPLE

See Also:

Constant Field Values

PROP_REQUIRED

static final java.lang.String PROP_REQUIRED

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

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

setHeader

void setHeader(java.lang.String header)

getHeader

java.lang.String getHeader()

setExample

void setExample(java.lang.String example)

getExample

java.lang.String getExample()

setRequired

void setRequired(boolean required)

isRequired

boolean isRequired()