com.vp.plugin.model

Interface IProcedure

All Superinterfaces:

IHasChildrenBaseModelElement, IModelElement, IModelElementParent

public interface IProcedure
extends IHasChildrenBaseModelElement

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATA_MODEL_CONCEPTUAL
static int	DATA_MODEL_LOGICAL
static int	DATA_MODEL_PHYSICAL
static java.lang.String	PROP_ANALYSIS_ITEM_DIAGRAM_IDS
static java.lang.String	PROP_ANALYSIS_ITEM_MODELS
static java.lang.String	PROP_COMMENT
static java.lang.String	PROP_CREATE_STATEMENT
static java.lang.String	PROP_DATA_MODEL
static java.lang.String	PROP_OPERATION_MODEL
static java.lang.String	PROP_PROCEDURE_NAME
static java.lang.String	PROP_PROCEDURE_TYPE
static java.lang.String	PROP_QUALITY_REASON
static java.lang.String	PROP_QUALITY_SCORE
static java.lang.String	PROP_RETURN_CLASS_MODEL
static java.lang.String	PROP_RETURN_PARAMETERS
static java.lang.String	PROP_RETURN_RESULT_SET
static java.lang.String	PROP_SCHEMA_LOOKUP
static java.lang.String	PROP_STEREOTYPES
static java.lang.String	PROP_SYNC_MAPPING_MODELS
static java.lang.String	PROP_TAGGED_VALUES

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

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

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

MODEL_QUALITY_SCORE_IGNORE, MODEL_QUALITY_SCORE_RECALCULATE, PROP_NAME

Method Summary

Modifier and Type	Method and Description
void	addAnalysisItemModel(IModelElement analysisItemModel)
void	addProcedureParameter(IProcedureParameter child)
void	addReturnParameter(IProcedureParameter returnParameter)
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)
int	analysisItemModelCount()
java.util.Iterator	analysisItemModelIterator() Returns an iterator over the model elements IModelElement.
IProcedureParameter	createProcedureParameter()
java.lang.String[]	getAnalysisItemDiagramIds()
IModelElement	getAnalysisItemModelByIndex(int index)
java.lang.String	getComment()
java.lang.String	getCreateStatement()
int	getDataModel()
IOperation	getOperationModel()
java.lang.String	getProcedureName()
IProcedureParameter	getProcedureParameterByIndex(int index)
IProcedureParameter	getProcedureParameterByName(java.lang.String name)
int	getProcedureType()
java.lang.String	getQualityReason() Quality reason, it is non-readable value for human
int	getQualityScore() Quality score, it is non-readable value for human
IClass	getReturnClassModel()
IProcedureParameter	getReturnParameterByIndex(int index)
IProcedureResultSet	getReturnResultSet()
IDBSchemaLookup	getSchemaLookup()
IModelElement	getSyncMappingModelByIndex(int index)
ITaggedValueContainer	getTaggedValues()
boolean	hasStereotype(java.lang.String name)
boolean	hasStereotypes(java.lang.String name) Deprecated. Replaced by hasStereotype
int	procedureParameterCount()
java.util.Iterator	procedureParameterIterator()
void	removeAnalysisItemModel(IModelElement analysisItemModel)
void	removeAnalysisItemModelByIndex(int index)
void	removeProcedureParameter(IProcedureParameter child)
void	removeProcedureParameterByIndex(int index)
void	removeReturnParameter(IProcedureParameter returnParameter)
void	removeReturnParameterByIndex(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	reorderProcedureParameter(IProcedureParameter[] childs)
int	returnParameterCount()
java.util.Iterator	returnParameterIterator() Returns an iterator over the model elements IProcedureParameter.
void	setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)
void	setComment(java.lang.String comment)
void	setCreateStatement(java.lang.String createStatement)
void	setDataModel(int dataModel)
void	setOperationModel(IOperation operationModel)
void	setProcedureName(java.lang.String procedureName)
void	setProcedureType(int procedureType)
void	setQualityReason(java.lang.String qualityReason)
void	setQualityScore(int qualityScore)
void	setReturnClassModel(IClass returnClassModel)
void	setReturnResultSet(IProcedureResultSet returnResultSet)
void	setSchemaLookup(IDBSchemaLookup schemaLookup)
void	setTaggedValues(ITaggedValueContainer taggedValues)
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.
IModelElement[]	toAnalysisItemModelArray()
IProcedureParameter[]	toProcedureParameterArray()
IProcedureParameter[]	toReturnParameterArray()
java.lang.String[]	toStereotypeArray()
IStereotype[]	toStereotypeModelArray()
java.lang.String[]	toStereotypesArray() Deprecated. Replaced by toStereotypeArray
IStereotype[]	toStereotypesModelArray() Deprecated. Replaced by toStereotypeModelArray
IModelElement[]	toSyncMappingModelArray()

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

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

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

addChild, addPropertyChangeListener, 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, 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, toFromRelationshipArray, toFromRelationshipEndArray, toModelPropertyArray, toPropertiesString, toRelationshipCount, toRelationshipEndCount, toRelationshipEndIterator, toRelationshipIterator, toSubDiagramArray, toToChartRelationshipArray, toToRelationshipArray, toToRelationshipEndArray

Field Detail

PROP_STEREOTYPES

static final java.lang.String PROP_STEREOTYPES

See Also:

Constant Field Values

PROP_TAGGED_VALUES

static final java.lang.String PROP_TAGGED_VALUES

See Also:

Constant Field Values

PROP_SYNC_MAPPING_MODELS

static final java.lang.String PROP_SYNC_MAPPING_MODELS

See Also:

Constant Field Values

PROP_ANALYSIS_ITEM_MODELS

static final java.lang.String PROP_ANALYSIS_ITEM_MODELS

See Also:

Constant Field Values

PROP_ANALYSIS_ITEM_DIAGRAM_IDS

static final java.lang.String PROP_ANALYSIS_ITEM_DIAGRAM_IDS

See Also:

Constant Field Values

PROP_QUALITY_SCORE

static final java.lang.String PROP_QUALITY_SCORE

See Also:

Constant Field Values

PROP_QUALITY_REASON

static final java.lang.String PROP_QUALITY_REASON

See Also:

Constant Field Values

PROP_RETURN_CLASS_MODEL

static final java.lang.String PROP_RETURN_CLASS_MODEL

See Also:

Constant Field Values

PROP_RETURN_PARAMETERS

static final java.lang.String PROP_RETURN_PARAMETERS

See Also:

Constant Field Values

PROP_RETURN_RESULT_SET

static final java.lang.String PROP_RETURN_RESULT_SET

See Also:

Constant Field Values

PROP_OPERATION_MODEL

static final java.lang.String PROP_OPERATION_MODEL

See Also:

Constant Field Values

PROP_SCHEMA_LOOKUP

static final java.lang.String PROP_SCHEMA_LOOKUP

See Also:

Constant Field Values

PROP_CREATE_STATEMENT

static final java.lang.String PROP_CREATE_STATEMENT

See Also:

Constant Field Values

PROP_PROCEDURE_NAME

static final java.lang.String PROP_PROCEDURE_NAME

See Also:

Constant Field Values

PROP_COMMENT

static final java.lang.String PROP_COMMENT

See Also:

Constant Field Values

PROP_PROCEDURE_TYPE

static final java.lang.String PROP_PROCEDURE_TYPE

See Also:

Constant Field Values

PROP_DATA_MODEL

static final java.lang.String PROP_DATA_MODEL

See Also:

Constant Field Values

DATA_MODEL_CONCEPTUAL

static final int DATA_MODEL_CONCEPTUAL

See Also:

Constant Field Values

DATA_MODEL_LOGICAL

static final int DATA_MODEL_LOGICAL

See Also:

Constant Field Values

DATA_MODEL_PHYSICAL

static final int DATA_MODEL_PHYSICAL

See Also:

Constant Field Values

Method Detail

addProcedureParameter

void addProcedureParameter(IProcedureParameter child)

removeProcedureParameter

void removeProcedureParameter(IProcedureParameter child)

getProcedureParameterByIndex

IProcedureParameter getProcedureParameterByIndex(int index)

removeProcedureParameterByIndex

void removeProcedureParameterByIndex(int index)

reorderProcedureParameter

void reorderProcedureParameter(IProcedureParameter[] childs)

procedureParameterCount

int procedureParameterCount()

procedureParameterIterator

java.util.Iterator procedureParameterIterator()

toProcedureParameterArray

IProcedureParameter[] toProcedureParameterArray()

createProcedureParameter

IProcedureParameter createProcedureParameter()

getProcedureParameterByName

IProcedureParameter getProcedureParameterByName(java.lang.String name)

addStereotype

void addStereotype(java.lang.String name)

Description copied from interface: IModelElement

Add a stereotype into this model element. If the IStereotype does not existing in current project. It will be auto created.

Specified by:

addStereotype in interface IModelElement

removeStereotype

void removeStereotype(java.lang.String name)

Description copied from interface: IModelElement

Remove a stereotype from this model element.

Specified by:

removeStereotype in interface IModelElement

addStereotype

void addStereotype(IStereotype stereotype)

Add a 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=2378

Specified by:

addStereotype in interface IModelElement

Parameters:

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.

Throws:

java.lang.IllegalArgumentException - if the stereotype is null, or its baseType does not match with modelType of this model element.

removeStereotype

void removeStereotype(IStereotype stereotype)

Remove a stereotype IStereotype from this model element. The IStereotype can belong to current project or referenced project(s).

Specified by:

removeStereotype in interface IModelElement

Parameters:

stereotype - the IStereotype will be removed from this model element.

hasStereotype

boolean hasStereotype(java.lang.String name)

Specified by:

hasStereotype in interface IModelElement

stereotypeCount

int stereotypeCount()

Specified by:

stereotypeCount in interface IModelElement

toStereotypeArray

java.lang.String[] toStereotypeArray()

stereotypeIterator

java.util.Iterator stereotypeIterator()

Returns an iterator over the names of the stereotypes.

stereotypeModelIterator

java.util.Iterator stereotypeModelIterator()

Returns an iterator over the model elements IStereotype.

Specified by:

stereotypeModelIterator in interface IModelElement

toStereotypeModelArray

IStereotype[] toStereotypeModelArray()

Specified by:

toStereotypeModelArray in interface IModelElement

addStereotypes

void addStereotypes(java.lang.String name)

Deprecated. Replaced by addStereotype

removeStereotypes

void removeStereotypes(java.lang.String name)

Deprecated. Replaced by removeStereotype

hasStereotypes

boolean hasStereotypes(java.lang.String name)

Deprecated. Replaced by hasStereotype

stereotypesCount

int stereotypesCount()

Deprecated. Replaced by stereotypeCount

toStereotypesArray

java.lang.String[] toStereotypesArray()

Deprecated. Replaced by toStereotypeArray

stereotypesIterator

java.util.Iterator stereotypesIterator()

Deprecated. Replaced by stereotypeIterator

stereotypesModelIterator

java.util.Iterator stereotypesModelIterator()

Deprecated. Replaced by stereotypeModelIterator

toStereotypesModelArray

IStereotype[] toStereotypesModelArray()

Deprecated. Replaced by toStereotypeModelArray

setTaggedValues

void setTaggedValues(ITaggedValueContainer taggedValues)

Specified by:

setTaggedValues in interface IModelElement

getTaggedValues

ITaggedValueContainer getTaggedValues()

Specified by:

getTaggedValues in interface IModelElement

addSyncMappingModel

void addSyncMappingModel(IModelElement syncMappingModel)

removeSyncMappingModel

void removeSyncMappingModel(IModelElement syncMappingModel)

getSyncMappingModelByIndex

IModelElement getSyncMappingModelByIndex(int index)

removeSyncMappingModelByIndex

void removeSyncMappingModelByIndex(int index)

syncMappingModelCount

int syncMappingModelCount()

syncMappingModelIterator

java.util.Iterator syncMappingModelIterator()

Returns an iterator over the model elements IModelElement.

toSyncMappingModelArray

IModelElement[] toSyncMappingModelArray()

addAnalysisItemModel

void addAnalysisItemModel(IModelElement analysisItemModel)

removeAnalysisItemModel

void removeAnalysisItemModel(IModelElement analysisItemModel)

getAnalysisItemModelByIndex

IModelElement getAnalysisItemModelByIndex(int index)

removeAnalysisItemModelByIndex

void removeAnalysisItemModelByIndex(int index)

analysisItemModelCount

int analysisItemModelCount()

analysisItemModelIterator

java.util.Iterator analysisItemModelIterator()

Returns an iterator over the model elements IModelElement.

toAnalysisItemModelArray

IModelElement[] toAnalysisItemModelArray()

setAnalysisItemDiagramIds

void setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)

getAnalysisItemDiagramIds

java.lang.String[] getAnalysisItemDiagramIds()

setQualityScore

void setQualityScore(int qualityScore)

getQualityScore

int getQualityScore()

Description copied from interface: IModelElement

Quality score, it is non-readable value for human

Specified by:

getQualityScore in interface IModelElement

setQualityReason

void setQualityReason(java.lang.String qualityReason)

getQualityReason

java.lang.String getQualityReason()

Description copied from interface: IModelElement

Quality reason, it is non-readable value for human

Specified by:

getQualityReason in interface IModelElement

setReturnClassModel

void setReturnClassModel(IClass returnClassModel)

getReturnClassModel

IClass getReturnClassModel()

addReturnParameter

void addReturnParameter(IProcedureParameter returnParameter)

removeReturnParameter

void removeReturnParameter(IProcedureParameter returnParameter)

getReturnParameterByIndex

IProcedureParameter getReturnParameterByIndex(int index)

removeReturnParameterByIndex

void removeReturnParameterByIndex(int index)

returnParameterCount

int returnParameterCount()

returnParameterIterator

java.util.Iterator returnParameterIterator()

Returns an iterator over the model elements IProcedureParameter.

toReturnParameterArray

IProcedureParameter[] toReturnParameterArray()

setReturnResultSet

void setReturnResultSet(IProcedureResultSet returnResultSet)

getReturnResultSet

IProcedureResultSet getReturnResultSet()

setOperationModel

void setOperationModel(IOperation operationModel)

getOperationModel

IOperation getOperationModel()

setSchemaLookup

void setSchemaLookup(IDBSchemaLookup schemaLookup)

getSchemaLookup

IDBSchemaLookup getSchemaLookup()

setCreateStatement

void setCreateStatement(java.lang.String createStatement)

getCreateStatement

java.lang.String getCreateStatement()

setProcedureName

void setProcedureName(java.lang.String procedureName)

getProcedureName

java.lang.String getProcedureName()

setComment

void setComment(java.lang.String comment)

getComment

java.lang.String getComment()

setProcedureType

void setProcedureType(int procedureType)

getProcedureType

int getProcedureType()

setDataModel

void setDataModel(int dataModel)

getDataModel

int getDataModel()