Interface MEComment

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ADTimeAble, ELComment, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEModelElement, MEStereotypeAble, METermAble, MMCommentContainerAble, MMStereotypeAble

public interface MEComment
extends ADHistoryAble, ADTimeAble, MEStereotypeAble, ELComment, MECommentAble

A comment gives the ability to attach various remarks to elements. A comment carries no semantic force but may contain information that is useful to a modeler. A comment can be owned by any element.

See Also:

• MECommentHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	MEComment.VAttr

Method Summary

Modifier and Type	Method	Description
List<MECommentAssign>	assignComment(List<? extends ELElement> seq)	Assigns this comment to a list of elements.
<T extends MECommentAble> List<T>	getCommentAble(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All elements which are annotated by the current object.
<T extends MECommentAble> List<T>	getCommentAble(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getCommentAble and filters its return values according to the given stereotype value.
List<MECommentAssign>	getOwnedCommentAssign(K_CONTROL_OPTION... behaviourFlags)	All comment assigns owned by this element.
MMCommentContainerAble	getOwningCommentContainer()	The element owning this comment.
String	getTextExpandedValue()	Returns the body of the current object where fill-ins are expanded.
void	setCommentAble(List<? extends MECommentAble> values)	Set the value of View CommentAble.

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface ADTimeAble

getLtime, getNote, getUsrName, setLtime, setNote, setUsrName

Methods inherited from interface ELComment

getBody, setBody

Methods inherited from interface ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Method Details

getTextExpandedValue

String getTextExpandedValue()
                     throws InoNetException,
SrvErrorException

Returns the body of the current object where fill-ins are expanded.

Throws:

InoNetException

SrvErrorException

getCommentAble

<T extends MECommentAble> List<T> getCommentAble(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                          throws InoNetException,
SrvErrorException

All elements which are annotated by the current object.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getCommentAble

<T extends MECommentAble> List<T> getCommentAble(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                          throws InoNetException,
SrvErrorException

The method calls getCommentAble and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

setCommentAble

void setCommentAble(List<? extends MECommentAble> values)
             throws InoNetException,
SrvErrorException

Set the value of View CommentAble.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

assignComment

List<MECommentAssign> assignComment(List<? extends ELElement> seq)
                             throws InoNetException,
SrvErrorException

Assigns this comment to a list of elements.

Parameters:

seq - List of ELElement

Throws:

InoNetException

SrvErrorException

getOwnedCommentAssign

List<MECommentAssign> getOwnedCommentAssign(K_CONTROL_OPTION... behaviourFlags)
                                     throws InoNetException,
SrvErrorException

All comment assigns owned by this element.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwningCommentContainer

MMCommentContainerAble getOwningCommentContainer()
                                          throws InoNetException,
SrvErrorException

The element owning this comment.

Throws:

InoNetException

SrvErrorException