Package com.nomagic.uml2.ext.magicdraw.statemachines.mdprotocolstatemachines

Interface ProtocolStateMachine

All Superinterfaces:

BaseElement, Behavior, BehavioredClassifier, Class, Classifier, java.lang.Cloneable, java.lang.Comparable, Element, EncapsulatedClassifier, org.eclipse.emf.ecore.EObject, MDObject, com.dassault_systemes.modeler.foundation.model.ModelElement, ModelObject, NamedElement, Namespace, org.eclipse.emf.common.notify.Notifier, PackageableElement, ParameterableElement, RedefinableElement, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, StateMachine, StructuredClassifier, TemplateableElement, Type

public interface ProtocolStateMachine
extends StateMachine

A representation of the model object 'Protocol State Machine'.

A ProtocolStateMachine is always defined in the context of a Classifier. It specifies which BehavioralFeatures of the Classifier can be called in which State and under which conditions, thus specifying the allowed invocation sequences on the Classifier's BehavioralFeatures. A ProtocolStateMachine specifies the possible and permitted Transitions on the instances of its context Classifier, together with the BehavioralFeatures that carry the Transitions. In this manner, an instance lifecycle can be specified for a Classifier, by defining the order in which the BehavioralFeatures can be activated and the States through which an instance progresses during its existence.

The following features are supported:

• Conformance
• protocol Conformance Of General Machine
• Interface
• port Of Protocol

See Also:

UMLPackage.getProtocolStateMachine()

Model:

annotation="MOF package='statemachines.mdprotocolstatemachines'"

Generated:

Method Summary

Modifier and Type	Method	Description
java.util.Collection<Port>	get_portOfProtocol()	Returns the value of the 'port Of Protocol' reference list.
java.util.Collection<ProtocolConformance>	get_protocolConformanceOfGeneralMachine()	Returns the value of the 'protocol Conformance Of General Machine' reference list.
java.util.Collection<ProtocolConformance>	getConformance()	Returns the value of the 'Conformance' containment reference list.
Interface	getInterface()	Returns the value of the 'Interface' container reference.
boolean	has_portOfProtocol()
boolean	has_protocolConformanceOfGeneralMachine()
boolean	hasConformance()
void	setInterface(Interface value)	Sets the value of the 'Interface' container reference.

Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement

accept, addPropertyChangeListener, canAdd, canAdd, canAddChild, canBeDeleted, firePropertyChange, getClassType, getHumanName, getHumanType, isEditable, removePropertyChangeListener, sGetID

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.commonbehaviors.mdbasicbehaviors.Behavior

get_behavioredClassifierOfClassifierBehavior, get_behavioredClassifierOfOwnedBehavior, get_behaviorExecutionSpecificationOfBehavior, get_behaviorOfRedefinedBehavior, get_callBehaviorActionOfBehavior, get_connectorOfContract, get_decisionNodeOfDecisionInput, get_objectFlowOfSelection, get_objectFlowOfTransformation, get_objectNodeOfSelection, get_opaqueExpressionOfBehavior, get_reduceActionOfReducer, get_stateOfDoActivity, get_stateOfEntry, get_stateOfExit, get_transitionOfEffect, getContext, getEvent, getObservation, getOwnedParameter, getOwnedParameterSet, getPostcondition, getPrecondition, getRedefinedBehavior, getSpecification, has_behaviorExecutionSpecificationOfBehavior, has_behaviorOfRedefinedBehavior, has_callBehaviorActionOfBehavior, has_connectorOfContract, has_decisionNodeOfDecisionInput, has_objectFlowOfSelection, has_objectFlowOfTransformation, has_objectNodeOfSelection, has_opaqueExpressionOfBehavior, has_reduceActionOfReducer, hasEvent, hasObservation, hasOwnedParameter, hasOwnedParameterSet, hasPostcondition, hasPrecondition, hasRedefinedBehavior, isReentrant, set_behavioredClassifierOfClassifierBehavior, set_behavioredClassifierOfOwnedBehavior, set_stateOfDoActivity, set_stateOfEntry, set_stateOfExit, set_transitionOfEffect, setReentrant, setSpecification

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.commonbehaviors.mdbasicbehaviors.BehavioredClassifier

getClassifierBehavior, getInterfaceRealization, getOwnedBehavior, hasInterfaceRealization, hasOwnedBehavior, setClassifierBehavior

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class

getExtension, getNestedClassifier, getOwnedAttribute, getOwnedOperation, getOwnedReception, getSuperClass, hasExtension, hasNestedClassifier, hasOwnedOperation, hasOwnedReception, hasSuperClass, isAbstract, isActive, setAbstract, setActive

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Classifier

get_classifierOfRedefinedClassifier, get_classifierTemplateParameterOfConstrainingClassifier, get_componentRealizationOfRealizingClassifier, get_createObjectActionOfClassifier, get_exceptionHandlerOfExceptionType, get_generalizationOfGeneral, get_informationFlowOfConveyed, get_informationItemOfRepresented, get_instanceSpecificationOfClassifier, get_interfaceOfNestedClassifier, get_readExtentActionOfClassifier, get_readIsClassifiedObjectActionOfClassifier, get_reclassifyObjectActionOfNewClassifier, get_reclassifyObjectActionOfOldClassifier, get_redefinableElementOfRedefinitionContext, get_substitutionOfContract, get_unmarshallActionOfUnmarshallType, getAttribute, getCollaborationUse, getFeature, getGeneral, getGeneralization, getInheritedMember, getOwnedTemplateSignature, getOwnedUseCase, getPowertypeExtent, getRedefinedClassifier, getRepresentation, getSubstitution, getTemplateParameter, getUMLClass, getUseCase, has_classifierOfRedefinedClassifier, has_classifierTemplateParameterOfConstrainingClassifier, has_componentRealizationOfRealizingClassifier, has_createObjectActionOfClassifier, has_exceptionHandlerOfExceptionType, has_generalizationOfGeneral, has_informationFlowOfConveyed, has_informationItemOfRepresented, has_instanceSpecificationOfClassifier, has_readExtentActionOfClassifier, has_readIsClassifiedObjectActionOfClassifier, has_reclassifyObjectActionOfNewClassifier, has_reclassifyObjectActionOfOldClassifier, has_redefinableElementOfRedefinitionContext, has_substitutionOfContract, has_unmarshallActionOfUnmarshallType, hasAttribute, hasCollaborationUse, hasFeature, hasGeneral, hasGeneralization, hasInheritedMember, hasOwnedUseCase, hasPowertypeExtent, hasRedefinedClassifier, hasSubstitution, hasUseCase, isFinalSpecialization, set_interfaceOfNestedClassifier, setFinalSpecialization, setOwnedTemplateSignature, setRepresentation, setTemplateParameter, setUMLClass

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element

get_activityPartitionOfRepresents, get_commentOfAnnotatedElement, get_constraintOfConstrainedElement, get_diagramOfContext, get_directedRelationshipOfSource, get_directedRelationshipOfTarget, get_elementOfSyncElement, get_elementTaggedValue, get_elementValueOfElement, get_relationshipOfRelatedElement, getAppliedStereotype, getOwnedComment, getOwnedElement, getOwner, getSyncElement, getTaggedValue, has_activityPartitionOfRepresents, has_commentOfAnnotatedElement, has_constraintOfConstrainedElement, has_diagramOfContext, has_directedRelationshipOfSource, has_directedRelationshipOfTarget, has_elementOfSyncElement, has_elementValueOfElement, has_relationshipOfRelatedElement, hasAppliedStereotype, hasElementTaggedValue, hasOwnedComment, hasOwnedElement, hasTaggedValue, setOwner, setSyncElement

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.compositestructures.mdports.EncapsulatedClassifier

getOwnedPort, hasOwnedPort

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface com.nomagic.magicdraw.foundation.MDObject

getID, getMDExtension, getMdExtensions, setID

Methods inherited from interface com.dassault_systemes.modeler.foundation.model.ModelElement

canChangeElementOwner, eDynamicGet, getElementOwner, getLocalID, getObjectParent, setLocalID, sGetLocalID

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.base.ModelObject

get_representationText, ignoringRefGetValue, ignoringRefGetValue, isSet, refGetValue, refGetValue, refSetValue, refSetValue, set_representationText

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement

get_considerIgnoreFragmentOfMessage, get_durationObservationOfEvent, get_informationFlowOfInformationSource, get_informationFlowOfInformationTarget, get_messageOfSignature, get_namespaceOfMember, get_timeObservationOfEvent, getClientDependency, getName, getNameExpression, getNamespace, getQualifiedName, getSupplierDependency, has_considerIgnoreFragmentOfMessage, has_durationObservationOfEvent, has_informationFlowOfInformationSource, has_informationFlowOfInformationTarget, has_messageOfSignature, has_namespaceOfMember, has_timeObservationOfEvent, hasClientDependency, hasSupplierDependency, setName, setNameExpression, setNamespace

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Namespace

getElementImport, getImportedMember, getMember, getOwnedDiagram, getOwnedMember, getOwnedRule, getPackageImport, hasElementImport, hasImportedMember, hasMember, hasOwnedDiagram, hasOwnedMember, hasOwnedRule, hasPackageImport

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.PackageableElement

get_componentOfPackagedElement, get_elementImportOfImportedElement, get_manifestationOfUtilizedElement, getOwningPackage, getVisibility, has_elementImportOfImportedElement, has_manifestationOfUtilizedElement, set_componentOfPackagedElement, setOwningPackage, setVisibility

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.auxiliaryconstructs.mdtemplates.ParameterableElement

get_templateParameterOfDefault, get_templateParameterOfOwnedDefault, get_templateParameterSubstitutionOfActual, get_templateParameterSubstitutionOfOwnedActual, getOwningTemplateParameter, has_templateParameterOfDefault, has_templateParameterSubstitutionOfActual, set_templateParameterOfOwnedDefault, set_templateParameterSubstitutionOfOwnedActual, setOwningTemplateParameter, setTemplateParameter

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.RedefinableElement

get_redefinableElementOfRedefinedElement, getRedefinedElement, getRedefinitionContext, has_redefinableElementOfRedefinedElement, hasRedefinedElement, hasRedefinitionContext, isLeaf, setLeaf

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refInvokeOperation, refInvokeOperation, refSetValue

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.statemachines.mdbehaviorstatemachines.StateMachine

get_stateMachineOfExtendedStateMachine, getConnectionPoint, getExtendedStateMachine, getRegion, getSubmachineState, has_stateMachineOfExtendedStateMachine, hasConnectionPoint, hasExtendedStateMachine, hasRegion, hasSubmachineState

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.compositestructures.mdinternalstructures.StructuredClassifier

getOwnedConnector, getPart, getRole, hasOwnedAttribute, hasOwnedConnector, hasPart, hasRole

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.auxiliaryconstructs.mdtemplates.TemplateableElement

getTemplateBinding, hasTemplateBinding, setOwnedTemplateSignature

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Type

get_associationOfEndType, get_behavioralFeatureOfRaisedException, get_operationOfRaisedException, get_typedElementOfType, getPackage, has_associationOfEndType, has_behavioralFeatureOfRaisedException, has_operationOfRaisedException, has_typedElementOfType, setPackage

Method Detail

getConformance

java.util.Collection<ProtocolConformance> getConformance()

Returns the value of the 'Conformance' containment reference list. The list contents are of type ProtocolConformance. It is bidirectional and its opposite is 'Specific Machine'. Conformance between ProtocolStateMachine

Returns:

the value of the 'Conformance' containment reference list.

See Also:

UMLPackage.getProtocolStateMachine_Conformance(), ProtocolConformance.getSpecificMachine()

Model:

opposite="specificMachine" containment="true" resolveProxies="true" ordered="false"

Generated:

get_protocolConformanceOfGeneralMachine

java.util.Collection<ProtocolConformance> get_protocolConformanceOfGeneralMachine()

Returns the value of the 'protocol Conformance Of General Machine' reference list. The list contents are of type ProtocolConformance. It is bidirectional and its opposite is 'General Machine'.

If the meaning of the 'protocol Conformance Of General Machine' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'protocol Conformance Of General Machine' reference list.

See Also:

UMLPackage.getProtocolStateMachine__protocolConformanceOfGeneralMachine(), ProtocolConformance.getGeneralMachine()

Model:

opposite="generalMachine" ordered="false"

Generated:

get_portOfProtocol

java.util.Collection<Port> get_portOfProtocol()

Returns the value of the 'port Of Protocol' reference list. The list contents are of type Port. It is bidirectional and its opposite is 'Protocol'.

If the meaning of the 'port Of Protocol' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'port Of Protocol' reference list.

See Also:

UMLPackage.getProtocolStateMachine__portOfProtocol(), Port.getProtocol()

Model:

opposite="protocol" ordered="false"

Generated:

getInterface

@CheckForNull
Interface getInterface()

Returns the value of the 'Interface' container reference. It is bidirectional and its opposite is 'Protocol'. Specifies the namespace in which the protocol state machine is defined.

Returns:

the value of the 'Interface' container reference.

See Also:

setInterface(Interface), UMLPackage.getProtocolStateMachine_Interface(), Interface.getProtocol()

Model:

opposite="protocol" transient="false" ordered="false"

Generated:

setInterface

void setInterface(@CheckForNull
                  Interface value)

Sets the value of the 'Interface' container reference.

Parameters:

value - the new value of the 'Interface' container reference.

See Also:

getInterface()

Generated:

hasConformance

boolean hasConformance()
                throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

has_protocolConformanceOfGeneralMachine

boolean has_protocolConformanceOfGeneralMachine()
                                         throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

has_portOfProtocol

boolean has_portOfProtocol()
                    throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated: