IRestResourceResponseBody

All Superinterfaces:: IModelElement, IModelElementParent

public interface IRestResourceResponseBody
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_RESPONSE_CODE`
`static java.lang.String`	`PROP_TAGGED_VALUES`
`static java.lang.String`	`PROP_VOICES`
`static int`	`RESPONSE_CODE_100_CONTINUE`
`static int`	`RESPONSE_CODE_101_SWITCHING_PROTOCOLS`
`static int`	`RESPONSE_CODE_102_PROCESSING`
`static int`	`RESPONSE_CODE_103_EARLY_HINTS`
`static int`	`RESPONSE_CODE_200_OK`
`static int`	`RESPONSE_CODE_201_CREATED`
`static int`	`RESPONSE_CODE_202_ACCEPTED`
`static int`	`RESPONSE_CODE_203_NON_AUTHORITATIVE_INFORMATION`
`static int`	`RESPONSE_CODE_204_NO_CONTENT`
`static int`	`RESPONSE_CODE_205_RESET_CONTENT`
`static int`	`RESPONSE_CODE_206_PARTIAL_CONTENT`
`static int`	`RESPONSE_CODE_207_MULTI_STATUS`
`static int`	`RESPONSE_CODE_208_ALREADY_REPORTED`
`static int`	`RESPONSE_CODE_226_IM_USED`
`static int`	`RESPONSE_CODE_300_MULTIPLE_CHOICES`
`static int`	`RESPONSE_CODE_301_MOVED_PERMANENTLY`
`static int`	`RESPONSE_CODE_302_FOUND`
`static int`	`RESPONSE_CODE_303_SEE_OTHER`
`static int`	`RESPONSE_CODE_304_NOT_MODIFIED`
`static int`	`RESPONSE_CODE_305_USE_PROXY`
`static int`	`RESPONSE_CODE_306_SWITCH_PROXY`
`static int`	`RESPONSE_CODE_307_TEMPORARY_REDIRECT`
`static int`	`RESPONSE_CODE_308_PERMANENT_REDIRECT`
`static int`	`RESPONSE_CODE_400_BAD_REQUEST`
`static int`	`RESPONSE_CODE_401_UNAUTHORIZED`
`static int`	`RESPONSE_CODE_402_PAYMENT_REQUIRED`
`static int`	`RESPONSE_CODE_403_FORBIDDEN`
`static int`	`RESPONSE_CODE_404_NOT_FOUND`
`static int`	`RESPONSE_CODE_405_METHOD_NOT_ALLOWED`
`static int`	`RESPONSE_CODE_406_NOT_ACCEPTABLE`
`static int`	`RESPONSE_CODE_407_PROXY_AUTHENTICATION_REQUIRED`
`static int`	`RESPONSE_CODE_408_REQUEST_TIMEOUT`
`static int`	`RESPONSE_CODE_409_CONFLICT`
`static int`	`RESPONSE_CODE_410_GONE`
`static int`	`RESPONSE_CODE_411_LENGTH_REQUIRED`
`static int`	`RESPONSE_CODE_412_PRECONDITION_FAILED`
`static int`	`RESPONSE_CODE_413_PAYLOAD_TOO_LARGE`
`static int`	`RESPONSE_CODE_414_URI_TOO_LONG`
`static int`	`RESPONSE_CODE_415_UNSUPPORTED_MEDIA_TYPE`
`static int`	`RESPONSE_CODE_416_RANGE_NOT_SATISFIABLE`
`static int`	`RESPONSE_CODE_417_EXPECTATION_FAILED`
`static int`	`RESPONSE_CODE_421_MISDIRECTED_REQUEST`
`static int`	`RESPONSE_CODE_422_UNPROCESSABLE_ENTITY`
`static int`	`RESPONSE_CODE_423_LOCKED`
`static int`	`RESPONSE_CODE_424_FAILED_DEPENDENCY`
`static int`	`RESPONSE_CODE_426_UPGRADE_REQUIRED`
`static int`	`RESPONSE_CODE_428_PRECONDITION_REQUIRED`
`static int`	`RESPONSE_CODE_429_TOO_MANY_REQUESTS`
`static int`	`RESPONSE_CODE_431_REQUEST_HEADER_FIELDS_TOO_LARGE`
`static int`	`RESPONSE_CODE_451_UNAVAILABLE_FOR_LEGAL_REASONS`
`static int`	`RESPONSE_CODE_500_INTERNAL_SERVER_ERROR`
`static int`	`RESPONSE_CODE_501_NOT_IMPLEMENTED`
`static int`	`RESPONSE_CODE_502_BAD_GATEWAY`
`static int`	`RESPONSE_CODE_503_SERVICE_UNAVAILABLE`
`static int`	`RESPONSE_CODE_504_GATEWAY_TIMEOUT`
`static int`	`RESPONSE_CODE_505_HTTP_VERSION_NOT_SUPPORTED`
`static int`	`RESPONSE_CODE_506_VARIANT_ALSO_NEGOTIATES`
`static int`	`RESPONSE_CODE_507_INSUFFICIENT_STORAGE`
`static int`	`RESPONSE_CODE_508_LOOP_DETECTED`
`static int`	`RESPONSE_CODE_510_NOT_EXTENDED`
`static int`	`RESPONSE_CODE_511_NETWORK_AUTHENTICATION_REQUIRED`
`static int`	`RESPONSE_CODE_DEFAULT`

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

All Methods Instance Methods Abstract 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()` `IRelationshipEnd`s that connect from this model element.
`java.util.Iterator`	`fromRelationshipIterator()` `ISimpleRelationship`s 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)`
`int`	`getResponseCode()`
`ITaggedValueContainer`	`getTaggedValues()`
`IVoice`	`getVoiceByIndex(int index)`
`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`	`setResponseCode(int responseCode)`
`void`	`setTaggedValues(ITaggedValueContainer taggedValues)`
`ISimpleRelationship[]`	`toFromRelationshipArray()` `ISimpleRelationship`s that connect from this model element.
`IRelationshipEnd[]`	`toFromRelationshipEndArray()` `IRelationshipEnd`s 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()` `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.
`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_RESPONSE_CODE
```
static final java.lang.String PROP_RESPONSE_CODE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_DEFAULT
```
static final int RESPONSE_CODE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_100_CONTINUE
```
static final int RESPONSE_CODE_100_CONTINUE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_101_SWITCHING_PROTOCOLS
```
static final int RESPONSE_CODE_101_SWITCHING_PROTOCOLS
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_102_PROCESSING
```
static final int RESPONSE_CODE_102_PROCESSING
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_103_EARLY_HINTS
```
static final int RESPONSE_CODE_103_EARLY_HINTS
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_200_OK
```
static final int RESPONSE_CODE_200_OK
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_201_CREATED
```
static final int RESPONSE_CODE_201_CREATED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_202_ACCEPTED
```
static final int RESPONSE_CODE_202_ACCEPTED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_203_NON_AUTHORITATIVE_INFORMATION
```
static final int RESPONSE_CODE_203_NON_AUTHORITATIVE_INFORMATION
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_204_NO_CONTENT
```
static final int RESPONSE_CODE_204_NO_CONTENT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_205_RESET_CONTENT
```
static final int RESPONSE_CODE_205_RESET_CONTENT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_206_PARTIAL_CONTENT
```
static final int RESPONSE_CODE_206_PARTIAL_CONTENT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_207_MULTI_STATUS
```
static final int RESPONSE_CODE_207_MULTI_STATUS
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_208_ALREADY_REPORTED
```
static final int RESPONSE_CODE_208_ALREADY_REPORTED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_226_IM_USED
```
static final int RESPONSE_CODE_226_IM_USED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_300_MULTIPLE_CHOICES
```
static final int RESPONSE_CODE_300_MULTIPLE_CHOICES
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_301_MOVED_PERMANENTLY
```
static final int RESPONSE_CODE_301_MOVED_PERMANENTLY
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_302_FOUND
```
static final int RESPONSE_CODE_302_FOUND
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_303_SEE_OTHER
```
static final int RESPONSE_CODE_303_SEE_OTHER
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_304_NOT_MODIFIED
```
static final int RESPONSE_CODE_304_NOT_MODIFIED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_305_USE_PROXY
```
static final int RESPONSE_CODE_305_USE_PROXY
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_306_SWITCH_PROXY
```
static final int RESPONSE_CODE_306_SWITCH_PROXY
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_307_TEMPORARY_REDIRECT
```
static final int RESPONSE_CODE_307_TEMPORARY_REDIRECT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_308_PERMANENT_REDIRECT
```
static final int RESPONSE_CODE_308_PERMANENT_REDIRECT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_400_BAD_REQUEST
```
static final int RESPONSE_CODE_400_BAD_REQUEST
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_401_UNAUTHORIZED
```
static final int RESPONSE_CODE_401_UNAUTHORIZED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_402_PAYMENT_REQUIRED
```
static final int RESPONSE_CODE_402_PAYMENT_REQUIRED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_403_FORBIDDEN
```
static final int RESPONSE_CODE_403_FORBIDDEN
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_404_NOT_FOUND
```
static final int RESPONSE_CODE_404_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_405_METHOD_NOT_ALLOWED
```
static final int RESPONSE_CODE_405_METHOD_NOT_ALLOWED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_406_NOT_ACCEPTABLE
```
static final int RESPONSE_CODE_406_NOT_ACCEPTABLE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_407_PROXY_AUTHENTICATION_REQUIRED
```
static final int RESPONSE_CODE_407_PROXY_AUTHENTICATION_REQUIRED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_408_REQUEST_TIMEOUT
```
static final int RESPONSE_CODE_408_REQUEST_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_409_CONFLICT
```
static final int RESPONSE_CODE_409_CONFLICT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_410_GONE
```
static final int RESPONSE_CODE_410_GONE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_411_LENGTH_REQUIRED
```
static final int RESPONSE_CODE_411_LENGTH_REQUIRED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_412_PRECONDITION_FAILED
```
static final int RESPONSE_CODE_412_PRECONDITION_FAILED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_413_PAYLOAD_TOO_LARGE
```
static final int RESPONSE_CODE_413_PAYLOAD_TOO_LARGE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_414_URI_TOO_LONG
```
static final int RESPONSE_CODE_414_URI_TOO_LONG
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_415_UNSUPPORTED_MEDIA_TYPE
```
static final int RESPONSE_CODE_415_UNSUPPORTED_MEDIA_TYPE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_416_RANGE_NOT_SATISFIABLE
```
static final int RESPONSE_CODE_416_RANGE_NOT_SATISFIABLE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_417_EXPECTATION_FAILED
```
static final int RESPONSE_CODE_417_EXPECTATION_FAILED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_421_MISDIRECTED_REQUEST
```
static final int RESPONSE_CODE_421_MISDIRECTED_REQUEST
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_422_UNPROCESSABLE_ENTITY
```
static final int RESPONSE_CODE_422_UNPROCESSABLE_ENTITY
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_423_LOCKED
```
static final int RESPONSE_CODE_423_LOCKED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_424_FAILED_DEPENDENCY
```
static final int RESPONSE_CODE_424_FAILED_DEPENDENCY
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_426_UPGRADE_REQUIRED
```
static final int RESPONSE_CODE_426_UPGRADE_REQUIRED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_428_PRECONDITION_REQUIRED
```
static final int RESPONSE_CODE_428_PRECONDITION_REQUIRED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_429_TOO_MANY_REQUESTS
```
static final int RESPONSE_CODE_429_TOO_MANY_REQUESTS
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_431_REQUEST_HEADER_FIELDS_TOO_LARGE
```
static final int RESPONSE_CODE_431_REQUEST_HEADER_FIELDS_TOO_LARGE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_451_UNAVAILABLE_FOR_LEGAL_REASONS
```
static final int RESPONSE_CODE_451_UNAVAILABLE_FOR_LEGAL_REASONS
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_500_INTERNAL_SERVER_ERROR
```
static final int RESPONSE_CODE_500_INTERNAL_SERVER_ERROR
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_501_NOT_IMPLEMENTED
```
static final int RESPONSE_CODE_501_NOT_IMPLEMENTED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_502_BAD_GATEWAY
```
static final int RESPONSE_CODE_502_BAD_GATEWAY
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_503_SERVICE_UNAVAILABLE
```
static final int RESPONSE_CODE_503_SERVICE_UNAVAILABLE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_504_GATEWAY_TIMEOUT
```
static final int RESPONSE_CODE_504_GATEWAY_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_505_HTTP_VERSION_NOT_SUPPORTED
```
static final int RESPONSE_CODE_505_HTTP_VERSION_NOT_SUPPORTED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_506_VARIANT_ALSO_NEGOTIATES
```
static final int RESPONSE_CODE_506_VARIANT_ALSO_NEGOTIATES
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_507_INSUFFICIENT_STORAGE
```
static final int RESPONSE_CODE_507_INSUFFICIENT_STORAGE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_508_LOOP_DETECTED
```
static final int RESPONSE_CODE_508_LOOP_DETECTED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_510_NOT_EXTENDED
```
static final int RESPONSE_CODE_510_NOT_EXTENDED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_CODE_511_NETWORK_AUTHENTICATION_REQUIRED
```
static final int RESPONSE_CODE_511_NETWORK_AUTHENTICATION_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()
```
  - setResponseCode
```
void setResponseCode(int responseCode)
```
  - getResponseCode
```
int getResponseCode()
```

Interface IRestResourceResponseBody

Field Summary

Fields inherited from interface com.vp.plugin.model.IModelElement

Method Summary

Methods inherited from interface com.vp.plugin.model.IModelElement

Field Detail

PROP_DOCUMENTATION

PROP_VOICES

PROP_TAGGED_VALUES

PROP_HEADER

PROP_EXAMPLE

PROP_RESPONSE_CODE

RESPONSE_CODE_DEFAULT

RESPONSE_CODE_100_CONTINUE

RESPONSE_CODE_101_SWITCHING_PROTOCOLS

RESPONSE_CODE_102_PROCESSING

RESPONSE_CODE_103_EARLY_HINTS

RESPONSE_CODE_200_OK

RESPONSE_CODE_201_CREATED

RESPONSE_CODE_202_ACCEPTED

RESPONSE_CODE_203_NON_AUTHORITATIVE_INFORMATION

RESPONSE_CODE_204_NO_CONTENT

RESPONSE_CODE_205_RESET_CONTENT

RESPONSE_CODE_206_PARTIAL_CONTENT

RESPONSE_CODE_207_MULTI_STATUS

RESPONSE_CODE_208_ALREADY_REPORTED

RESPONSE_CODE_226_IM_USED

RESPONSE_CODE_300_MULTIPLE_CHOICES

RESPONSE_CODE_301_MOVED_PERMANENTLY

RESPONSE_CODE_302_FOUND

RESPONSE_CODE_303_SEE_OTHER

RESPONSE_CODE_304_NOT_MODIFIED

RESPONSE_CODE_305_USE_PROXY

RESPONSE_CODE_306_SWITCH_PROXY

RESPONSE_CODE_307_TEMPORARY_REDIRECT

RESPONSE_CODE_308_PERMANENT_REDIRECT

RESPONSE_CODE_400_BAD_REQUEST

RESPONSE_CODE_401_UNAUTHORIZED

RESPONSE_CODE_402_PAYMENT_REQUIRED

RESPONSE_CODE_403_FORBIDDEN

RESPONSE_CODE_404_NOT_FOUND

RESPONSE_CODE_405_METHOD_NOT_ALLOWED

RESPONSE_CODE_406_NOT_ACCEPTABLE

RESPONSE_CODE_407_PROXY_AUTHENTICATION_REQUIRED

RESPONSE_CODE_408_REQUEST_TIMEOUT

RESPONSE_CODE_409_CONFLICT

RESPONSE_CODE_410_GONE

RESPONSE_CODE_411_LENGTH_REQUIRED

RESPONSE_CODE_412_PRECONDITION_FAILED

RESPONSE_CODE_413_PAYLOAD_TOO_LARGE

RESPONSE_CODE_414_URI_TOO_LONG

RESPONSE_CODE_415_UNSUPPORTED_MEDIA_TYPE

RESPONSE_CODE_416_RANGE_NOT_SATISFIABLE

RESPONSE_CODE_417_EXPECTATION_FAILED

RESPONSE_CODE_421_MISDIRECTED_REQUEST

RESPONSE_CODE_422_UNPROCESSABLE_ENTITY

RESPONSE_CODE_423_LOCKED

RESPONSE_CODE_424_FAILED_DEPENDENCY

RESPONSE_CODE_426_UPGRADE_REQUIRED

RESPONSE_CODE_428_PRECONDITION_REQUIRED

RESPONSE_CODE_429_TOO_MANY_REQUESTS

RESPONSE_CODE_431_REQUEST_HEADER_FIELDS_TOO_LARGE

RESPONSE_CODE_451_UNAVAILABLE_FOR_LEGAL_REASONS

RESPONSE_CODE_500_INTERNAL_SERVER_ERROR

RESPONSE_CODE_501_NOT_IMPLEMENTED

RESPONSE_CODE_502_BAD_GATEWAY

RESPONSE_CODE_503_SERVICE_UNAVAILABLE

RESPONSE_CODE_504_GATEWAY_TIMEOUT

RESPONSE_CODE_505_HTTP_VERSION_NOT_SUPPORTED

RESPONSE_CODE_506_VARIANT_ALSO_NEGOTIATES

RESPONSE_CODE_507_INSUFFICIENT_STORAGE

RESPONSE_CODE_508_LOOP_DETECTED

RESPONSE_CODE_510_NOT_EXTENDED

RESPONSE_CODE_511_NETWORK_AUTHENTICATION_REQUIRED

Method Detail

fromRelationshipCount

toFromRelationshipArray

fromRelationshipIterator

toRelationshipCount

toToRelationshipArray