Package de.mid.innovator.srv2api.icw2class

Interface CLOperation

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, CLBehavioralFeature, CLDeclarationAble, CLFeature, CLParameterAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELFeature, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELRedefAble, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEStereotypeAble, METriggerReferenceAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface CLOperation
extends CLBehavioralFeature, CLDeclarationAble, METriggerReferenceAble

An operation is a behavioral feature of a classifier that specifies the name, type, parameters and constraints for invoking an associated behavior.

See Also:

CLOperationHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CLOperation.VAttr

Method Summary

Modifier and Type	Method	Description
CLArtifact	getArtifact()	The artifact that owns this operation.
MESimpleConstraint	getBodyCondition()	An optional constraint on the result values of an invocation of this operation.
java.util.List<BECallEvent>	getCallEvent(K_CONTROL_OPTION... behaviourFlags)	Returns the CLOperation of the call event.
java.util.List<ANCallOperation>	getCallOperationAction(K_CONTROL_OPTION... behaviourFlags)	The action that transmits the operation call request to the target object, where it may cause the invocation of associated behavior.
CLDataType	getDataType()	The data type that owns this operation.
<T extends BEEvent> java.util.List<T>	getEvent(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All occurrences where this operation is used as event.
CLInterface	getInterface()	The interface that owns this operation.
<T extends IAMessage> java.util.List<T>	getMessage(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All messages using this CLOperation as signature.
ARG_CLOperationDeclaration	getModifyOperationDeclaration()	Returns the declaration of this operation with all parameters.
CLClass	getOwnClass()	The class that owns this operation.
java.util.List<MESimpleConstraint>	getPostcondition(K_CONTROL_OPTION... behaviourFlags)	An optional set of constraints specifying the state of the system when the operation is completed.
java.util.List<MESimpleConstraint>	getPrecondition(K_CONTROL_OPTION... behaviourFlags)	An optional set of constraints on the state of the system when the operation is invoked.
CLProperty	getProperty()	The property accessed by this method.
boolean	isQuery()	True, if this operation is a query.
void	modifyOperationDeclaration(CLOperation ohOp, java.lang.String strDecl, java.lang.String strName, java.util.List<ARG_CLParameterDeclaration> seqPar, ARG_CLParameterDeclaration valParReturn, int idStereoOp, int idStereoPar, int idModel)	Modifies the declaration of this operation with all parameters.
void	setProperty(CLProperty value)	Set the value of Foreign Key Property.
void	setQuery(boolean value)	Set the value of Attribut IsQuery.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLBehavioralFeature

getConcurrency, getImplemented, getImplementing, getMethod, getOwnedParameter, getRaisedException, isAbstract, setAbstract, setConcurrency, setImplemented, setMethod, setRaisedException

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLParameterAble

getFormalParameter, getFormalParameter, getOwnedParam, getOwnedParameterSet, getReturnResult, setOwnedParam

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELFeature

getEntryInGroupAble, getEntryInGroupAble, getUsingViewElement, isStatic, setStatic

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELRedefAble

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement

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

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAble

getMEOwnedMember, getMEPackageImport

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, 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, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Detail

isQuery

boolean isQuery()
         throws InoNetException,
                SrvErrorException

True, if this operation is a query.

Throws:

InoNetException

SrvErrorException

setQuery

void setQuery(boolean value)
       throws InoNetException,
              SrvErrorException

Set the value of Attribut IsQuery.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getModifyOperationDeclaration

ARG_CLOperationDeclaration getModifyOperationDeclaration()
                                                  throws InoNetException,
                                                         SrvErrorException

Returns the declaration of this operation with all parameters.

Throws:

InoNetException

SrvErrorException

modifyOperationDeclaration

void modifyOperationDeclaration(CLOperation ohOp,
                                java.lang.String strDecl,
                                java.lang.String strName,
                                java.util.List<ARG_CLParameterDeclaration> seqPar,
                                ARG_CLParameterDeclaration valParReturn,
                                int idStereoOp,
                                int idStereoPar,
                                int idModel)
                         throws InoNetException,
                                SrvErrorException

Modifies the declaration of this operation with all parameters.

Parameters:

ohOp - operation element

strDecl - declaration of the operation

strName - name of the operation

seqPar - list of parameters

valParReturn - return parameter

idStereoOp - id of operation stereotype

idStereoPar - id for new parameter stereotype

idModel - id of model package

Throws:

InoNetException

SrvErrorException

getEvent

<T extends BEEvent> java.util.List<T> getEvent(java.lang.Class<T> returnType,
                                               K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
                                               SrvErrorException

All occurrences where this operation is used as event.

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

getMessage

<T extends IAMessage> java.util.List<T> getMessage(java.lang.Class<T> returnType,
                                                   K_CONTROL_OPTION... behaviourFlags)
                                            throws InoNetException,
                                                   SrvErrorException

All messages using this CLOperation as signature.

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

getProperty

CLProperty getProperty()
                throws InoNetException,
                       SrvErrorException

The property accessed by this method.

Throws:

InoNetException

SrvErrorException

setProperty

void setProperty(CLProperty value)
          throws InoNetException,
                 SrvErrorException

Set the value of Foreign Key Property.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getCallEvent

java.util.List<BECallEvent> getCallEvent(K_CONTROL_OPTION... behaviourFlags)
                                  throws InoNetException,
                                         SrvErrorException

Returns the CLOperation of the call event.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getCallOperationAction

java.util.List<ANCallOperation> getCallOperationAction(K_CONTROL_OPTION... behaviourFlags)
                                                throws InoNetException,
                                                       SrvErrorException

The action that transmits the operation call request to the target object, where it may cause the invocation of associated behavior.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getPrecondition

java.util.List<MESimpleConstraint> getPrecondition(K_CONTROL_OPTION... behaviourFlags)
                                            throws InoNetException,
                                                   SrvErrorException

An optional set of constraints on the state of the system when the operation is invoked.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getPostcondition

java.util.List<MESimpleConstraint> getPostcondition(K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
                                                    SrvErrorException

An optional set of constraints specifying the state of the system when the operation is completed.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getBodyCondition

MESimpleConstraint getBodyCondition()
                             throws InoNetException,
                                    SrvErrorException

An optional constraint on the result values of an invocation of this operation.

Throws:

InoNetException

SrvErrorException

getArtifact

CLArtifact getArtifact()
                throws InoNetException,
                       SrvErrorException

The artifact that owns this operation.

Throws:

InoNetException

SrvErrorException

getOwnClass

CLClass getOwnClass()
             throws InoNetException,
                    SrvErrorException

The class that owns this operation.

Throws:

InoNetException

SrvErrorException

getDataType

CLDataType getDataType()
                throws InoNetException,
                       SrvErrorException

The data type that owns this operation.

Throws:

InoNetException

SrvErrorException

getInterface

CLInterface getInterface()
                  throws InoNetException,
                         SrvErrorException

The interface that owns this operation.

Throws:

InoNetException

SrvErrorException