Overview  Package   Class  Use  Help 
SDK Help DE  EN
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

de.mid.innovator.srv2api.icw2sm
Interface SMStateMachine

All Superinterfaces:
ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, BEBehavior, CLBehavioredClassifier, CLClass, CLClassifier, CLDeclarationAble, CLDeclarationAbleClassifier, CLEncapsulatedClassifier, CLParameterAble, CLStructuredClassifier, CLTemplateAbleElement, CLTemplateParameterAbleElement, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELType, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMFormatAble, MMLabelAble, MMLabelTextAttachmentAble, MMMenuAble, MMStereotypeAble, MMTextAble
All Known Subinterfaces:
SMProtocolStateMachine
public interface SMStateMachine
extends BEBehavior, MMMenuAble

State machines can be used to express the behavior of part of a system. Behavior is modeled as a traversal of a graph of state nodes interconnected by one or more joined transition arcs that are triggered by the dispatching of series of (event) occurrences. During this traversal, the state machine executes a series of activities associated with various elements of the state machine.

See Also:
SMStateMachineHelper

Nested Class Summary
static class SMStateMachine.VAttr
           
 
Method Summary
 SMDia getDiagram()
          The state diagram for this state machine.
 List<SMEntryPoint> getEntryPoint(K_CONTROL_OPTION... behaviourFlags)
          The set of entry points owned by the statemachine.
 List<SMExitPoint> getExitPoint(K_CONTROL_OPTION... behaviourFlags)
          The set of exit points owned by the state machine.
 List<SMProtocolStateMachine> getGeneral(K_CONTROL_OPTION... behaviourFlags)
          The general protocol state machine
 List<SMProtocolStateMachine> getGeneral(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getGeneral and filters its return values according to the given stereotype value.
 ARG_PRPresContextLayout getLayout()
          Retrieves the layout information of the SMStateMachine.
 List<SMRegion> getRegion(K_CONTROL_OPTION... behaviourFlags)
           
<T extends SMStateMachine>
List<T>
getSubmachine(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)
          Determines all state machines which are assigned to submachine states of the given state machine.
<T extends SMStateMachine>
List<T>
getSubmachine(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getSubmachine and filters its return values according to the given stereotype value.
 List<SMRegularState> getSubmachineState()
          All states of this sub state machine.
 void layout(String format, K_ORIENTATION orientation, int marginLeft, int marginRight, int marginTop, int marginBottom, int horPage, int verPage)
          Sets the layout information of the SMStateMachine.
 void setGeneral(List<? extends SMProtocolStateMachine> values)
          Set the value of View General.
 
Methods inherited from interface de.mid.innovator.srv2api.icw2be.BEBehavior
getBehavioredClassifier, getBehaviorExecSpec, getBehaviorOwnedRule, getCallBehaviorAction, getConnector, getDecisionNodeR, getDoActivityOwningState, getEntryOwningState, getExitOwningState, getFinishEvent, getFinishEvent, getModifyBehaviorDeclaration, getObjectFlowSelectionR, getObjectFlowWithSelection, getObjectFlowWithSelection, getObjectFlowWithTransformation, getObjectFlowWithTransformation, getObjectNodeR, getObjectNodeWithSelection, getObjectNodeWithSelection, getOwnedParameter, getOwningTransition, getPictureRawData, getPostcondition, getPrecondition, getSpecification, getStartEvent, getStartEvent, isClassifierBehavior, isReentrant, maintain, modifyBehaviorDeclaration, setClassifierBehavior, setReentrant, setSpecification
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLClass
getNestedClassifier, getOwnedAttribute, getOwnedOperation, getOwnedReception, isActive, setActive
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEPackageAble
getComponent, getManifest
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble
getMENamespace
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
getUUID, setUUID
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLBehavioredClassifier
getClassifierBehavior, getInterfaceRealization, getOwnedBehavior, getOwnedProtocolStateMachine, getOwnedTrigger, getOwnedTrigger
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLEncapsulatedClassifier
getOwnedPort
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLStructuredClassifier
getCollaborationUse, getOwnedConnector, getOwnedProperty, getRepresentation
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLClassifier
dialogFolderRedefine, getAggregatedClassifier, getAggregatedClassifier, getAggregatedOrComposedClassifier, getAggregatedOrComposedClassifier, getAggregatingClassifier, getAggregatingClassifier, getAggregatingOrComposingClassifier, getAggregatingOrComposingClassifier, getClassifierInstance, getClassifierTemplateParameter, getComposedClassifier, getComposedClassifier, getComposingClassifier, getComposingClassifier, getContract, getContract, getContractSubstitution, getCreateObjectAction, getExceptionHandler, getInstSpec, getInterface, getOwnClass, getOwnedRule, getOwnedTemplateParameter, getOwnedUseCase, getProvidedInterface, getProvidedInterface, getProvidedInterfaceDirect, getProvidedInterfaceDirect, getRealizingClassifierRealization, getRequiredInterface, getRequiredInterface, getRequiredInterfaceDirect, getRequiredInterfaceDirect, getSubstitution, getTypedBCProperty, getTypedObjectNode, getTypedParameter, getTypedProperty, getTypedVariable, getUnmarshallAction, getUseCase
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELClassifier
getAssociation, getAssociation, getAssociationEndFirstTypedBySelf, getAssociationEndFirstTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelf, getAssociationEndTypedBySelf, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationNavigableFrom, getAssociationNavigableFrom, getAssociationOfSelfOrGeneralTransitive, getAssociationOfSelfOrGeneralTransitive, getAssociationTypedBySelf, getAssociationTypedBySelf, getClassifierViewGroup, getEffectiveRedefinerOfAssocEnd, getEffectiveRedefinerOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getGeneralDirect, getGeneralDirect, getGeneralGeneralizationSet, getGeneralGeneralizationSet, getGeneralization, getGeneralTransitive, getGeneralTransitive, getItemDefinition, getOwnedAndInheritedMember, getOwnedAndInheritedMember, getPropertyNavigableFrom, getPropertyNavigableFrom, getPropertyNavigableFromSelfOrGeneralTransitive, getPropertyNavigableFromSelfOrGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitiveNotAbstract, getSelfAndSpecificTransitiveNotAbstract, getSpecialization, getSpecificDirect, getSpecificDirect, getSpecificGeneralization, getSpecificGeneralizationSet, getSpecificGeneralizationSet, getSpecificTransitive, getSpecificTransitive, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getTypedCLStructureEntry, getTypedMaskField, getTypesOfEffectiveSubsetterOfAssocEnd, getTypesOfEffectiveSubsetterOfAssocEnd, getViewTransitive, getViewTransitive, isAbstract, isRoot, isSpecificTransitive, setAbstract
 
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.ELType
getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADVersionAble
getVersionFile, getVersionList, getVersionListWithoutOpenInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADOptionAble
getOwnedOption, modifyOptionDlg
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADLockAble
getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock
 
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.icw2elem.ELPackageAble
getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage
 
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.ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADAccessAble
getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAble
getMEOwnedMember, getMEPackageImport
 
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.icw2model.MENamedElement
getMESupplierDependency, getMESupplierMappingDependency
 
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.icw2meta.ADClientAble
getAnnotation, getLogic, getLogic, getPresentationContext, getSection
 
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.icw2model.MEStereotypeAble
getClientMappingDependency, getOutgoingConceptRealization, getProxyAsgProperty, getRealizedConcept, getRealizedConcept, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, replaceRealizedConcepts, setMapped, setRealizedConcept, setRequirementOfStakeholder
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble
getOwnedComment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble
assignStereotypeDlg, cloneElement, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, isCloneAbleElement, modifyStereotypePropertyValuesByName, setStereotype, setStereotypePropertyInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADReferenceAble
getReferenceContainer, setReferenceContainer
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateAbleElement
getActualTemplateParameter, getActualTemplateParameter, getOwnedTemplateParameter, getTemplateBindingSource, getTemplateBindingTarget, getTemplateParameter
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateParameterAbleElement
getActualParameterSubstitution, getOwningTemplateParameter, getTemplateParameter
 
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.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.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLParameterAble
getFormalParameter, getFormalParameter, getOwnedParam, getOwnedParameterSet, getReturnResult, setOwnedParam
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMMenuAble
getMenu, getMenuItem, getMenuItemsForTransform
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMFormatAble
copyFormatDlg, getCopyFormatDlgInit, getFormat
 

Method Detail

getDiagram

SMDia getDiagram()
                 throws InoNetException,
                        SrvErrorException
The state diagram for this state machine.

Throws:
InoNetException
SrvErrorException

getEntryPoint

List<SMEntryPoint> getEntryPoint(K_CONTROL_OPTION... behaviourFlags)
                                 throws InoNetException,
                                        SrvErrorException
The set of entry points owned by the statemachine.

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

List<SMExitPoint> getExitPoint(K_CONTROL_OPTION... behaviourFlags)
                               throws InoNetException,
                                      SrvErrorException
The set of exit points owned by the state machine.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted.

getGeneral

List<SMProtocolStateMachine> getGeneral(K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
                                               SrvErrorException
The general protocol state machine

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getGeneral

List<SMProtocolStateMachine> getGeneral(MMStereotype stereotype,
                                        K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
                                               SrvErrorException
The method calls getGeneral and filters its return values according to the given stereotype value.

Parameters:
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

getLayout

ARG_PRPresContextLayout getLayout()
                                  throws InoNetException,
                                         SrvErrorException
Retrieves the layout information of the SMStateMachine.

Throws:
InoNetException
SrvErrorException

getRegion

List<SMRegion> getRegion(K_CONTROL_OPTION... behaviourFlags)
                         throws InoNetException,
                                SrvErrorException
Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted.

getSubmachine

<T extends SMStateMachine> List<T> getSubmachine(Class<T> returnType,
                                                 K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
                                                    SrvErrorException
Determines all state machines which are assigned to submachine states of the given state machine.

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

getSubmachine

<T extends SMStateMachine> List<T> getSubmachine(Class<T> returnType,
                                                 MMStereotype stereotype,
                                                 K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
                                                    SrvErrorException
The method calls getSubmachine 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

getSubmachineState

List<SMRegularState> getSubmachineState()
                                        throws InoNetException,
                                               SrvErrorException
All states of this sub state machine.

Throws:
InoNetException
SrvErrorException

layout

void layout(String format,
            K_ORIENTATION orientation,
            int marginLeft,
            int marginRight,
            int marginTop,
            int marginBottom,
            int horPage,
            int verPage)
            throws InoNetException,
                   SrvErrorException
Sets the layout information of the SMStateMachine.

Parameters:
format - format of the presentation context
orientation - orientation of the presentation context
marginLeft - margin on the left border
marginRight - margin on the right border
marginTop - margin on the top border
marginBottom - margin on the bottom border
horPage - number of horinzontal pages
verPage - number of vertical pages
Throws:
InoNetException
SrvErrorException

setGeneral

void setGeneral(List<? extends SMProtocolStateMachine> values)
                throws InoNetException,
                       SrvErrorException
Set the value of View General.

Parameters:
values - The value to be set.
Throws:
InoNetException
SrvErrorException
Overview  Package   Class  Use  Help 
SDK Help DE  EN
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

© MID GmbH, All rights reserved.