public interface IRestResource extends INoChildrenBaseModelElement
Modifier and Type | Field and Description |
---|---|
static int |
METHOD_DELETE |
static int |
METHOD_GET |
static int |
METHOD_HEAD |
static int |
METHOD_PATCH |
static int |
METHOD_POST |
static int |
METHOD_PUT |
static java.lang.String |
PROP_ANALYSIS_ITEM_DIAGRAM_IDS |
static java.lang.String |
PROP_ANALYSIS_ITEM_MODELS |
static java.lang.String |
PROP_CONSUMES |
static java.lang.String |
PROP_METHOD |
static java.lang.String |
PROP_OPERATION_ID |
static java.lang.String |
PROP_PARAMETERS |
static java.lang.String |
PROP_PRODUCES |
static java.lang.String |
PROP_QUALITY_REASON |
static java.lang.String |
PROP_QUALITY_SCORE |
static java.lang.String |
PROP_REQUEST_BODIES |
static java.lang.String |
PROP_RESOURCE_TYPE |
static java.lang.String |
PROP_RESPONSE_BODIES |
static java.lang.String |
PROP_STEREOTYPES |
static java.lang.String |
PROP_SUMMARY |
static java.lang.String |
PROP_SYNC_MAPPING_MODELS |
static java.lang.String |
PROP_TAGGED_VALUES |
static java.lang.String |
PROP_TAGS |
static java.lang.String |
PROP_URI |
static int |
RESOURCE_TYPE_SERVICE_CONSUMER |
static int |
RESOURCE_TYPE_SERVICE_PROVIDER |
PROP_BACKLOG_ACTIVITY_ID, PROP_COMMENTS, PROP_DOCUMENTATION, PROP_GENERIC_VALUES, PROP_PM_AUTHOR, PROP_PM_CREATE_DATE_TIME, PROP_PM_DIFFICULTY, PROP_PM_DISCIPLINE, PROP_PM_ITERATION, PROP_PM_LAST_MODIFIED, PROP_PM_PHASE, PROP_PM_PRIORITY, PROP_PM_STATUS, PROP_PM_VERSION, PROP_REFERENCED_BY_DIAGRAM_IDS, PROP_REFERENCED_BY_MODEL_ADDRESSES, PROP_REFERENCES, PROP_TRANSIT_FROM, PROP_TRANSIT_TO, PROP_USER_ID, PROP_USER_ID_LAST_NUMERIC_VALUE, PROP_USER_ID_PARENT, PROP_VOICES
MODEL_QUALITY_SCORE_IGNORE, MODEL_QUALITY_SCORE_RECALCULATE, PROP_NAME
Modifier and Type | Method and Description |
---|---|
void |
addAnalysisItemModel(IModelElement analysisItemModel) |
void |
addParameter(IRestResourceParameter parameter) |
void |
addRequestBodie(IRestResourceRequestBody requestBodie) |
void |
addResponseBodie(IRestResourceResponseBody responseBodie) |
void |
addStereotype(IStereotype stereotype)
Add a stereotype
IStereotype into this model element. |
void |
addStereotype(java.lang.String name)
Add a stereotype into this model element.
|
void |
addStereotypes(java.lang.String name)
Deprecated.
Replaced by addStereotype
|
void |
addSyncMappingModel(IModelElement syncMappingModel) |
void |
addTag(IApiTag tag) |
int |
analysisItemModelCount() |
java.util.Iterator |
analysisItemModelIterator()
Returns an iterator over the model elements
IModelElement . |
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[] |
getAnalysisItemDiagramIds() |
IModelElement |
getAnalysisItemModelByIndex(int index) |
java.lang.String[] |
getConsumes() |
int |
getMethod() |
java.lang.String |
getOperationId() |
IRestResourceParameter |
getParameterByIndex(int index) |
java.lang.String[] |
getProduces() |
java.lang.String |
getQualityReason()
Quality reason, it is non-readable value for human
|
int |
getQualityScore()
Quality score, it is non-readable value for human
|
IRestResourceRequestBody |
getRequestBodieByIndex(int index) |
int |
getResourceType() |
IRestResourceResponseBody |
getResponseBodieByIndex(int index) |
java.lang.String |
getSummary() |
IModelElement |
getSyncMappingModelByIndex(int index) |
IApiTag |
getTagByIndex(int index) |
ITaggedValueContainer |
getTaggedValues() |
java.lang.String |
getUri() |
boolean |
hasStereotype(java.lang.String name) |
boolean |
hasStereotypes(java.lang.String name)
Deprecated.
Replaced by hasStereotype
|
int |
parameterCount() |
java.util.Iterator |
parameterIterator()
Returns an iterator over the model elements
IRestResourceParameter . |
void |
removeAnalysisItemModel(IModelElement analysisItemModel) |
void |
removeAnalysisItemModelByIndex(int index) |
void |
removeParameter(IRestResourceParameter parameter) |
void |
removeParameterByIndex(int index) |
void |
removeRequestBodie(IRestResourceRequestBody requestBodie) |
void |
removeRequestBodieByIndex(int index) |
void |
removeResponseBodie(IRestResourceResponseBody responseBodie) |
void |
removeResponseBodieByIndex(int index) |
void |
removeStereotype(IStereotype stereotype)
Remove a stereotype
IStereotype from this model element. |
void |
removeStereotype(java.lang.String name)
Remove a stereotype from this model element.
|
void |
removeStereotypes(java.lang.String name)
Deprecated.
Replaced by removeStereotype
|
void |
removeSyncMappingModel(IModelElement syncMappingModel) |
void |
removeSyncMappingModelByIndex(int index) |
void |
removeTag(IApiTag tag) |
void |
removeTagByIndex(int index) |
int |
requestBodieCount() |
java.util.Iterator |
requestBodieIterator()
Returns an iterator over the model elements
IRestResourceRequestBody . |
int |
responseBodieCount() |
java.util.Iterator |
responseBodieIterator()
Returns an iterator over the model elements
IRestResourceResponseBody . |
void |
setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds) |
void |
setConsumes(java.lang.String[] consumes) |
void |
setMethod(int method) |
void |
setOperationId(java.lang.String operationId) |
void |
setProduces(java.lang.String[] produces) |
void |
setQualityReason(java.lang.String qualityReason) |
void |
setQualityScore(int qualityScore) |
void |
setResourceType(int resourceType) |
void |
setSummary(java.lang.String summary) |
void |
setTaggedValues(ITaggedValueContainer taggedValues) |
void |
setUri(java.lang.String uri) |
int |
stereotypeCount() |
java.util.Iterator |
stereotypeIterator()
Returns an iterator over the names of the stereotypes.
|
java.util.Iterator |
stereotypeModelIterator()
Returns an iterator over the model elements
IStereotype . |
int |
stereotypesCount()
Deprecated.
Replaced by stereotypeCount
|
java.util.Iterator |
stereotypesIterator()
Deprecated.
Replaced by stereotypeIterator
|
java.util.Iterator |
stereotypesModelIterator()
Deprecated.
Replaced by stereotypeModelIterator
|
int |
syncMappingModelCount() |
java.util.Iterator |
syncMappingModelIterator()
Returns an iterator over the model elements
IModelElement . |
int |
tagCount() |
java.util.Iterator |
tagIterator()
Returns an iterator over the model elements
IApiTag . |
IModelElement[] |
toAnalysisItemModelArray() |
ISimpleRelationship[] |
toFromRelationshipArray()
ISimpleRelationship s that connect from this model element. |
IRelationshipEnd[] |
toFromRelationshipEndArray()
IRelationshipEnd s that connect from this model element. |
IRestResourceParameter[] |
toParameterArray() |
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. |
IRestResourceRequestBody[] |
toRequestBodieArray() |
IRestResourceResponseBody[] |
toResponseBodieArray() |
java.lang.String[] |
toStereotypeArray() |
IStereotype[] |
toStereotypeModelArray() |
java.lang.String[] |
toStereotypesArray()
Deprecated.
Replaced by toStereotypeArray
|
IStereotype[] |
toStereotypesModelArray()
Deprecated.
Replaced by toStereotypeModelArray
|
IModelElement[] |
toSyncMappingModelArray() |
IApiTag[] |
toTagArray() |
ISimpleRelationship[] |
toToRelationshipArray()
ISimpleRelationship s that connect to this model element. |
IRelationshipEnd[] |
toToRelationshipEndArray()
IRelationshipEnd s that connect to this model element. |
addComment, addGenericValue, addReference, addVoice, commentCount, commentIterator, genericValueCount, genericValueIterator, getBacklogActivityId, getCommentByIndex, getDescription, getGenericValueByIndex, getHTMLDescription, getHTMLDescription, getPmAuthor, getPmCreateDateTime, getPmDifficulty, getPmDiscipline, getPmIteration, getPmLastModified, getPmPhase, getPmPriority, getPmStatus, getPmVersion, getReferenceByIndex, getReferencedByDiagramIds, getReferencedByModelAddresses, getTransitFrom, getTransitTo, getUserID, getUserIDLastNumericValue, getUserIDParent, getVoiceByIndex, referenceCount, referenceIterator, removeComment, removeCommentByIndex, removeGenericValue, removeGenericValueByIndex, removeReference, removeReferenceByIndex, removeVoice, removeVoiceByIndex, setBacklogActivityId, setDescription, setHTMLDescription, setPmAuthor, setPmCreateDateTime, setPmDifficulty, setPmDiscipline, setPmIteration, setPmLastModified, setPmPhase, setPmPriority, setPmStatus, setPmVersion, setReferencedByDiagramIds, setReferencedByModelAddresses, setTransitFrom, setTransitTo, setUserID, setUserIDLastNumericValue, setUserIDParent, toCommentArray, toGenericValueArray, toReferenceArray, toVoiceArray, voiceCount, voiceIterator
addChild, addPropertyChangeListener, 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, getReferencedBys, getReferencingModels, getSubDiagramAt, indexOfSubDiagram, isMirrorModelElement, isTransientModel, removeChild, removeChildByIndex, removePropertyChangeListener, removeSubDiagram, setDocumentation, setHTMLDocumentation, setName, setNickDescription, setNickDocumentation, setNickHTMLDescription, setNickHTMLDocumentation, setNickname, subDiagramCount, subDiagramIterator, toChartRelationshipCount, toChartRelationshipIterator, toChildArray, toChildArray, toChildArray, toFromChartRelationshipArray, toModelPropertyArray, toPropertiesString, toSubDiagramArray, toToChartRelationshipArray
static final java.lang.String PROP_STEREOTYPES
static final java.lang.String PROP_TAGGED_VALUES
static final java.lang.String PROP_SYNC_MAPPING_MODELS
static final java.lang.String PROP_ANALYSIS_ITEM_MODELS
static final java.lang.String PROP_ANALYSIS_ITEM_DIAGRAM_IDS
static final java.lang.String PROP_QUALITY_SCORE
static final java.lang.String PROP_QUALITY_REASON
static final java.lang.String PROP_URI
static final java.lang.String PROP_METHOD
static final int METHOD_GET
static final int METHOD_PUT
static final int METHOD_POST
static final int METHOD_DELETE
static final int METHOD_PATCH
static final int METHOD_HEAD
static final java.lang.String PROP_TAGS
static final java.lang.String PROP_SUMMARY
static final java.lang.String PROP_OPERATION_ID
static final java.lang.String PROP_CONSUMES
static final java.lang.String PROP_PRODUCES
static final java.lang.String PROP_PARAMETERS
static final java.lang.String PROP_REQUEST_BODIES
static final java.lang.String PROP_RESPONSE_BODIES
static final java.lang.String PROP_RESOURCE_TYPE
static final int RESOURCE_TYPE_SERVICE_PROVIDER
static final int RESOURCE_TYPE_SERVICE_CONSUMER
int fromRelationshipCount()
ISimpleRelationship
that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445fromRelationshipCount
in interface IModelElement
ISimpleRelationship[] toFromRelationshipArray()
ISimpleRelationship
s that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445toFromRelationshipArray
in interface IModelElement
ISimpleRelationship
s that connect from this model elementjava.util.Iterator fromRelationshipIterator()
ISimpleRelationship
s that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445fromRelationshipIterator
in interface IModelElement
ISimpleRelationship
s that connect from this model elementint toRelationshipCount()
ISimpleRelationship
that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445toRelationshipCount
in interface IModelElement
ISimpleRelationship[] toToRelationshipArray()
ISimpleRelationship
s that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445toToRelationshipArray
in interface IModelElement
ISimpleRelationship
s that connect to this model elementjava.util.Iterator toRelationshipIterator()
ISimpleRelationship
s that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445toRelationshipIterator
in interface IModelElement
ISimpleRelationship
s that connect to this model elementint fromRelationshipEndCount()
IRelationshipEnd
that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445fromRelationshipEndCount
in interface IModelElement
IRelationshipEnd[] toFromRelationshipEndArray()
IRelationshipEnd
s that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445toFromRelationshipEndArray
in interface IModelElement
IRelationshipEnd
s that connect from this model elementjava.util.Iterator fromRelationshipEndIterator()
IRelationshipEnd
s that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445fromRelationshipEndIterator
in interface IModelElement
IRelationshipEnd
s that connect from this model elementint toRelationshipEndCount()
IRelationshipEnd
that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445toRelationshipEndCount
in interface IModelElement
IRelationshipEnd[] toToRelationshipEndArray()
IRelationshipEnd
s that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445toToRelationshipEndArray
in interface IModelElement
IRelationshipEnd
s that connect to this model elementjava.util.Iterator toRelationshipEndIterator()
IRelationshipEnd
s that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445toRelationshipEndIterator
in interface IModelElement
IRelationshipEnd
s that connect to this model elementvoid addStereotype(java.lang.String name)
IModelElement
IStereotype
does not existing in current project. It will be auto created.addStereotype
in interface IModelElement
void removeStereotype(java.lang.String name)
IModelElement
removeStereotype
in interface IModelElement
void addStereotype(IStereotype stereotype)
IStereotype
into this model element. The IStereotype
may belong to current project or referenced project(s). Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2378addStereotype
in interface IModelElement
stereotype
- the IStereotype
will be added into this model element. The baseType
of the IStereotype
is required to be matched with modelType
of this model element. If they are different, or stereotype is null, will cause an IllegalArgumentException.
java.lang.IllegalArgumentException
- if the stereotype
is null, or its baseType
does not match with modelType
of this model element.void removeStereotype(IStereotype stereotype)
IStereotype
from this model element. The IStereotype
can belong to current project or referenced project(s).removeStereotype
in interface IModelElement
stereotype
- the IStereotype
will be removed from this model element.boolean hasStereotype(java.lang.String name)
hasStereotype
in interface IModelElement
int stereotypeCount()
stereotypeCount
in interface IModelElement
java.lang.String[] toStereotypeArray()
java.util.Iterator stereotypeIterator()
java.util.Iterator stereotypeModelIterator()
IStereotype
.stereotypeModelIterator
in interface IModelElement
IStereotype[] toStereotypeModelArray()
toStereotypeModelArray
in interface IModelElement
void addStereotypes(java.lang.String name)
void removeStereotypes(java.lang.String name)
boolean hasStereotypes(java.lang.String name)
int stereotypesCount()
java.lang.String[] toStereotypesArray()
java.util.Iterator stereotypesIterator()
java.util.Iterator stereotypesModelIterator()
IStereotype[] toStereotypesModelArray()
void setTaggedValues(ITaggedValueContainer taggedValues)
setTaggedValues
in interface IModelElement
ITaggedValueContainer getTaggedValues()
getTaggedValues
in interface IModelElement
void addSyncMappingModel(IModelElement syncMappingModel)
void removeSyncMappingModel(IModelElement syncMappingModel)
IModelElement getSyncMappingModelByIndex(int index)
void removeSyncMappingModelByIndex(int index)
int syncMappingModelCount()
java.util.Iterator syncMappingModelIterator()
IModelElement
.IModelElement[] toSyncMappingModelArray()
void addAnalysisItemModel(IModelElement analysisItemModel)
void removeAnalysisItemModel(IModelElement analysisItemModel)
IModelElement getAnalysisItemModelByIndex(int index)
void removeAnalysisItemModelByIndex(int index)
int analysisItemModelCount()
java.util.Iterator analysisItemModelIterator()
IModelElement
.IModelElement[] toAnalysisItemModelArray()
void setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)
java.lang.String[] getAnalysisItemDiagramIds()
void setQualityScore(int qualityScore)
int getQualityScore()
IModelElement
getQualityScore
in interface IModelElement
void setQualityReason(java.lang.String qualityReason)
java.lang.String getQualityReason()
IModelElement
getQualityReason
in interface IModelElement
void setUri(java.lang.String uri)
java.lang.String getUri()
void setMethod(int method)
int getMethod()
void addTag(IApiTag tag)
void removeTag(IApiTag tag)
IApiTag getTagByIndex(int index)
void removeTagByIndex(int index)
int tagCount()
java.util.Iterator tagIterator()
IApiTag
.IApiTag[] toTagArray()
void setSummary(java.lang.String summary)
java.lang.String getSummary()
void setOperationId(java.lang.String operationId)
java.lang.String getOperationId()
void setConsumes(java.lang.String[] consumes)
java.lang.String[] getConsumes()
void setProduces(java.lang.String[] produces)
java.lang.String[] getProduces()
void addParameter(IRestResourceParameter parameter)
void removeParameter(IRestResourceParameter parameter)
IRestResourceParameter getParameterByIndex(int index)
void removeParameterByIndex(int index)
int parameterCount()
java.util.Iterator parameterIterator()
IRestResourceParameter
.IRestResourceParameter[] toParameterArray()
void addRequestBodie(IRestResourceRequestBody requestBodie)
void removeRequestBodie(IRestResourceRequestBody requestBodie)
IRestResourceRequestBody getRequestBodieByIndex(int index)
void removeRequestBodieByIndex(int index)
int requestBodieCount()
java.util.Iterator requestBodieIterator()
IRestResourceRequestBody
.IRestResourceRequestBody[] toRequestBodieArray()
void addResponseBodie(IRestResourceResponseBody responseBodie)
void removeResponseBodie(IRestResourceResponseBody responseBodie)
IRestResourceResponseBody getResponseBodieByIndex(int index)
void removeResponseBodieByIndex(int index)
int responseBodieCount()
java.util.Iterator responseBodieIterator()
IRestResourceResponseBody
.IRestResourceResponseBody[] toResponseBodieArray()
void setResourceType(int resourceType)
int getResourceType()