Package de.mid.innovator.srv2api.icw2sm

Interface SMRegularState

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble, SMState, SMVertex

public interface SMRegularState
extends SMState

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SMRegularState.VAttr

Method Summary

Modifier and Type	Method	Description
java.util.List<BETrigger>	getDeferreableTrigger(K_CONTROL_OPTION... behaviourFlags)	A list of triggers that are candidates to be retained by the state machine if they trigger no transitions out of the state (not consumed).
<T extends BEBehavior> java.util.List<T>	getDoActivity(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	An optional behavior that is executed while being in the state.
<T extends BEBehavior> java.util.List<T>	getEntry(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	An optional behavior that is executed whenever this state is entered regardless of the transition taken to reach the state.
java.util.List<SMEntryPoint>	getEntryPoint(K_CONTROL_OPTION... behaviourFlags)	The set of entry points owned by the state.
<T extends BEBehavior> java.util.List<T>	getExit(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	An optional behavior that is executed whenever this state is exited regardless of which transition was taken out of the state.
java.util.List<SMExitPoint>	getExitPoint(K_CONTROL_OPTION... behaviourFlags)	The set of exit points owned by the state.
java.util.List<SMRegion>	getRegion(K_CONTROL_OPTION... behaviourFlags)	The regions owned directly by the state.
SMStateMachine	getSubmachine()	The sub state machine of this state.
java.util.List<SMTransInt>	getTransition(K_CONTROL_OPTION... behaviourFlags)	The set of transitions onwed by the state.
boolean	hasTriggerByRef(MEModelElement refObj)	True, if the state contains a deferred trigger which is identified by argument refObj.
boolean	isComposite()	True, if the given state contains a region.
boolean	isSubmachineState()	True, if the given state is a submachine state.
void	setSubmachine(SMStateMachine value)	Set the value of Foreign Key Submachine.

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.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.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.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.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

Methods inherited from interface de.mid.innovator.srv2api.icw2sm.SMState

getObjectNode, getOwnedRule, getStateInvariant

Methods inherited from interface de.mid.innovator.srv2api.icw2sm.SMVertex

getComesFromVertex, getComesFromVertex, getContainer, getGoesToVertex, getGoesToVertex, getIncoming, getOutgoing, getReachedVertex, getReachedVertex, isBetweenOrthogonalRegions, isLeft, isReached

Method Detail

hasTriggerByRef

boolean hasTriggerByRef(MEModelElement refObj)
                 throws InoNetException,
                        SrvErrorException

True, if the state contains a deferred trigger which is identified by argument refObj. Valid specializations of MEModelElement are BETrigger, BEEvent, CLSignal or CLOperation.

Parameters:

refObj - A further instance of type MEModelElement which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

isComposite

boolean isComposite()
             throws InoNetException,
                    SrvErrorException

True, if the given state contains a region.

Throws:

InoNetException

SrvErrorException

isSubmachineState

boolean isSubmachineState()
                   throws InoNetException,
                          SrvErrorException

True, if the given state is a submachine state.

Throws:

InoNetException

SrvErrorException

getSubmachine

SMStateMachine getSubmachine()
                      throws InoNetException,
                             SrvErrorException

The sub state machine of this state.

Throws:

InoNetException

SrvErrorException

setSubmachine

void setSubmachine(SMStateMachine value)
            throws InoNetException,
                   SrvErrorException

Set the value of Foreign Key Submachine.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getExit

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

An optional behavior that is executed whenever this state is exited regardless of which transition was taken out of the state.

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

Sorted:

the result may be sorted.

getEntry

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

An optional behavior that is executed whenever this state is entered regardless of the transition taken to reach the state.

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

Sorted:

the result may be sorted.

getDoActivity

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

An optional behavior that is executed while being in the state. The execution starts when this state is entered and stops either by itself or when the state is exited, whichever comes first.

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

Sorted:

the result may be sorted.

getDeferreableTrigger

java.util.List<BETrigger> getDeferreableTrigger(K_CONTROL_OPTION... behaviourFlags)
                                         throws InoNetException,
                                                SrvErrorException

A list of triggers that are candidates to be retained by the state machine if they trigger no transitions out of the state (not consumed).

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getRegion

java.util.List<SMRegion> getRegion(K_CONTROL_OPTION... behaviourFlags)
                            throws InoNetException,
                                   SrvErrorException

The regions owned directly by the state.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getTransition

java.util.List<SMTransInt> getTransition(K_CONTROL_OPTION... behaviourFlags)
                                  throws InoNetException,
                                         SrvErrorException

The set of transitions onwed by the state.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getEntryPoint

java.util.List<SMEntryPoint> getEntryPoint(K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException

The set of entry points owned by the state.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getExitPoint

java.util.List<SMExitPoint> getExitPoint(K_CONTROL_OPTION... behaviourFlags)
                                  throws InoNetException,
                                         SrvErrorException

The set of exit points owned by the state.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.