Package com.nomagic.uml2.ext.magicdraw.compositestructures.mdports

Interface Port

All Superinterfaces:
BaseElement, Cloneable, Comparable, ConnectableElement, DeploymentTarget, Element, org.eclipse.emf.ecore.EObject, Feature, MDObject, com.dassault_systemes.modeler.foundation.model.ModelElement, ModelObject, MultiplicityElement, NamedElement, org.eclipse.emf.common.notify.Notifier, ParameterableElement, Property, RedefinableElement, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, StructuralFeature, TypedElement
public interface Port extends Property
A representation of the model object 'Port'.

A Port is a property of an EncapsulatedClassifier that specifies a distinct interaction point between that EncapsulatedClassifier and its environment or between the (behavior of the) EncapsulatedClassifier and its internal parts. Ports are connected to Properties of the EncapsulatedClassifier by Connectors through which requests can be made to invoke BehavioralFeatures. A Port may specify the services an EncapsulatedClassifier provides (offers) to its environment as well as the services that an EncapsulatedClassifier expects (requires) of its environment. A Port may have an associated ProtocolStateMachine.

The following features are supported:

See Also:
Model:
annotation="MOF package='compositestructures.mdports'"
Generated:

  • Method Details

    • isBehavior

      boolean isBehavior()
      Returns the value of the 'Behavior' attribute. The default value is "false". Specifies whether requests arriving at this Port are sent to the classifier behavior of this EncapsulatedClassifier. Such a Port is referred to as a behavior Port. Any invocation of a BehavioralFeature targeted at a behavior Port will be handled by the instance of the owning EncapsulatedClassifier itself, rather than by any instances that it may contain.
      Returns:
      the value of the 'Behavior' attribute.
      See Also:
      Model:
      default="false" dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" ordered="false"
      Generated:

    • setBehavior

      void setBehavior(boolean value)
      Sets the value of the 'Behavior' attribute.
      Parameters:
      value - the new value of the 'Behavior' attribute.
      See Also:
      Generated:

    • isConjugated

      boolean isConjugated()
      Returns the value of the 'Conjugated' attribute. The default value is "false". Specifies the way that the provided and required Interfaces are derived from the Port’s Type.
      Returns:
      the value of the 'Conjugated' attribute.
      See Also:
      Model:
      default="false" dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" ordered="false"
      Generated:

    • setConjugated

      void setConjugated(boolean value)
      Sets the value of the 'Conjugated' attribute.
      Parameters:
      value - the new value of the 'Conjugated' attribute.
      See Also:
      Generated:

    • isService

      boolean isService()
      Returns the value of the 'Service' attribute. The default value is "true". If true, indicates that this Port is used to provide the published functionality of an EncapsulatedClassifier. If false, this Port is used to implement the EncapsulatedClassifier but is not part of the essential externally-visible functionality of the EncapsulatedClassifier and can, therefore, be altered or deleted along with the internal implementation of the EncapsulatedClassifier and other properties that are considered part of its implementation.
      Returns:
      the value of the 'Service' attribute.
      See Also:
      Model:
      default="true" dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" ordered="false"
      Generated:

    • setService

      void setService(boolean value)
      Sets the value of the 'Service' attribute.
      Parameters:
      value - the new value of the 'Service' attribute.
      See Also:
      Generated:

    • getRequired

      Collection<Interface> getRequired()
      Returns the value of the 'Required' reference list. The list contents are of type Interface. It is bidirectional and its opposite is 'port Of Required'. The Interfaces specifying the set of Operations and Receptions that the EncapsulatedCassifier expects its environment to handle via this port. This association is derived according to the value of isConjugated. If isConjugated is false, required is derived as the union of the sets of Interfaces used by the type of the Port and its supertypes. If isConjugated is true, it is derived as the union of the sets of Interfaces realized by the type of the Port and its supertypes, or directly from the type of the Port if the Port is typed by an Interface.
      Returns:
      the value of the 'Required' reference list.
      See Also:
      Model:
      opposite="_portOfRequired" transient="true" changeable="false" volatile="true" derived="true" ordered="false"
      Generated:

    • get_invocationActionOfOnPort

      Collection<InvocationAction> get_invocationActionOfOnPort()
      Returns the value of the 'invocation Action Of On Port' reference list. The list contents are of type InvocationAction. It is bidirectional and its opposite is 'On Port'.

      If the meaning of the 'invocation Action Of On Port' reference list isn't clear, there really should be more of a description here...

      Returns:
      the value of the 'invocation Action Of On Port' reference list.
      See Also:
      Model:
      opposite="onPort" ordered="false"
      Generated:

    • getProtocol

      @CheckForNull ProtocolStateMachine getProtocol()
      Returns the value of the 'Protocol' reference. It is bidirectional and its opposite is 'port Of Protocol'. An optional ProtocolStateMachine which describes valid interactions at this interaction point.
      Returns:
      the value of the 'Protocol' reference.
      See Also:
      Model:
      opposite="_portOfProtocol" ordered="false"
      Generated:

    • setProtocol

      void setProtocol(@CheckForNull ProtocolStateMachine value)
      Sets the value of the 'Protocol' reference.
      Parameters:
      value - the new value of the 'Protocol' reference.
      See Also:
      Generated:

    • getProvided

      Collection<Interface> getProvided()
      Returns the value of the 'Provided' reference list. The list contents are of type Interface. It is bidirectional and its opposite is 'port Of Provided'. The Interfaces specifying the set of Operations and Receptions that the EncapsulatedCclassifier offers to its environment via this Port, and which it will handle either directly or by forwarding it to a part of its internal structure. This association is derived according to the value of isConjugated. If isConjugated is false, provided is derived as the union of the sets of Interfaces realized by the type of the port and its supertypes, or directly from the type of the Port if the Port is typed by an Interface. If isConjugated is true, it is derived as the union of the sets of Interfaces used by the type of the Port and its supertypes.
      Returns:
      the value of the 'Provided' reference list.
      See Also:
      Model:
      opposite="_portOfProvided" transient="true" changeable="false" volatile="true" derived="true" ordered="false"
      Generated:

    • getRedefinedPort

      Collection<Port> getRedefinedPort()
      Returns the value of the 'Redefined Port' reference list. The list contents are of type Port. It is bidirectional and its opposite is 'port Of Redefined Port'. A Port may be redefined when its containing EncapsulatedClassifier is specialized. The redefining Port may have additional Interfaces to those that are associated with the redefined Port or it may replace an Interface by one of its subtypes.
      Returns:
      the value of the 'Redefined Port' reference list.
      See Also:
      Model:
      opposite="_portOfRedefinedPort" ordered="false"
      Generated:

    • get_portOfRedefinedPort

      Collection<Port> get_portOfRedefinedPort()
      Returns the value of the 'port Of Redefined Port' reference list. The list contents are of type Port. It is bidirectional and its opposite is 'Redefined Port'.

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

      Returns:
      the value of the 'port Of Redefined Port' reference list.
      See Also:
      Model:
      opposite="redefinedPort" ordered="false"
      Generated:

    • get_triggerOfPort

      Collection<Trigger> get_triggerOfPort()
      Returns the value of the 'trigger Of Port' reference list. The list contents are of type Trigger. It is bidirectional and its opposite is 'Port'.

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

      Returns:
      the value of the 'trigger Of Port' reference list.
      See Also:
      Model:
      opposite="port" ordered="false"
      Generated:

    • hasRequired

      boolean hasRequired() throws javax.jmi.reflect.JmiException
      Throws:
      javax.jmi.reflect.JmiException
      Generated:

    • has_invocationActionOfOnPort

      boolean has_invocationActionOfOnPort() throws javax.jmi.reflect.JmiException
      Throws:
      javax.jmi.reflect.JmiException
      Generated:

    • hasProvided

      boolean hasProvided() throws javax.jmi.reflect.JmiException
      Throws:
      javax.jmi.reflect.JmiException
      Generated:

    • hasRedefinedPort

      boolean hasRedefinedPort() throws javax.jmi.reflect.JmiException
      Throws:
      javax.jmi.reflect.JmiException
      Generated:

    • has_portOfRedefinedPort

      boolean has_portOfRedefinedPort() throws javax.jmi.reflect.JmiException
      Throws:
      javax.jmi.reflect.JmiException
      Generated:

    • has_triggerOfPort

      boolean has_triggerOfPort() throws javax.jmi.reflect.JmiException
      Throws:
      javax.jmi.reflect.JmiException
      Generated: