Interface Port
-
- All Superinterfaces:
BaseElement
,java.lang.Cloneable
,java.lang.Comparable
,ConnectableElement
,DeploymentTarget
,Element
,org.eclipse.emf.ecore.EObject
,Feature
,MDObject
,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:
UMLPackage.getPort()
- Model:
- annotation="MOF package='compositestructures.mdports'"
- Generated:
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Collection<InvocationAction>
get_invocationActionOfOnPort()
Returns the value of the 'invocation Action Of On Port' reference list.java.util.Collection<Port>
get_portOfRedefinedPort()
Returns the value of the 'port Of Redefined Port' reference list.java.util.Collection<Trigger>
get_triggerOfPort()
Returns the value of the 'trigger Of Port' reference list.ProtocolStateMachine
getProtocol()
Returns the value of the 'Protocol' reference.java.util.Collection<Interface>
getProvided()
Returns the value of the 'Provided' reference list.java.util.Collection<Port>
getRedefinedPort()
Returns the value of the 'Redefined Port' reference list.java.util.Collection<Interface>
getRequired()
Returns the value of the 'Required' reference list.boolean
has_invocationActionOfOnPort()
boolean
has_portOfRedefinedPort()
boolean
has_triggerOfPort()
boolean
hasProvided()
boolean
hasRedefinedPort()
boolean
hasRequired()
boolean
isBehavior()
Returns the value of the 'Behavior' attribute.boolean
isConjugated()
Returns the value of the 'Conjugated' attribute.boolean
isService()
Returns the value of the 'Service' attribute.void
setBehavior(boolean value)
Sets the value of the 'Behavior
' attribute.void
setConjugated(boolean value)
Sets the value of the 'Conjugated
' attribute.void
setProtocol(ProtocolStateMachine value)
Sets the value of the 'Protocol
' reference.void
setService(boolean value)
Sets the value of the 'Service
' attribute.-
Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement
accept, addPropertyChangeListener, atInsert, canAdd, canAdd, canAddChild, canAddInstance, canBeDeleted, canChangeParent, canDeleteChild, clone, dispose, firePropertyChange, getClassType, getHumanName, getHumanType, getObjectParent, isEditable, isParentOf, removeAllPropertyChangeListeners, removePropertyChangeListener, sGetID
-
Methods inherited from interface com.nomagic.uml2.ext.magicdraw.compositestructures.mdinternalstructures.ConnectableElement
get_collaborationOfCollaborationRole, get_lifelineOfRepresents, get_structuredClassifierOfRole, getEnd, getTemplateParameter, has_collaborationOfCollaborationRole, has_lifelineOfRepresents, has_structuredClassifierOfRole, hasEnd, setTemplateParameter
-
Methods inherited from interface com.nomagic.uml2.ext.magicdraw.deployments.mdnodes.DeploymentTarget
getDeployedElement, getDeployment, hasDeployedElement, hasDeployment
-
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 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.uml2.ext.magicdraw.classes.mdkernel.Feature
getFeaturingClassifier, isStatic, setFeaturingClassifier, setStatic
-
Methods inherited from interface com.nomagic.magicdraw.foundation.MDObject
getID, getMDExtension, getMdExtensions, setID
-
Methods inherited from interface com.nomagic.uml2.ext.magicdraw.base.ModelObject
get_representationText, getLocalID, ignoringRefGetValue, ignoringRefGetValue, isInvalid, isSet, refGetValue, refGetValue, refSetValue, refSetValue, set_representationText, setLocalID, sGetLocalID
-
Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.MultiplicityElement
getLower, getLowerValue, getUpper, getUpperValue, isOrdered, isUnique, setLowerValue, setOrdered, setUnique, setUpperValue
-
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, getVisibility, has_considerIgnoreFragmentOfMessage, has_durationObservationOfEvent, has_informationFlowOfInformationSource, has_informationFlowOfInformationTarget, has_messageOfSignature, has_namespaceOfMember, has_timeObservationOfEvent, hasClientDependency, hasSupplierDependency, setName, setNameExpression, setNamespace, setVisibility
-
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
-
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.Property
get_artifactOfOwnedAttribute, get_associationOfNavigableOwnedEnd, get_connectorEndOfPartWithPort, get_definedTaggedValue, get_interactionUseOfReturnValueRecipient, get_linkEndDataOfEnd, get_propertyOfRedefinedProperty, get_propertyOfSubsettedProperty, get_qualifierValueOfQualifier, get_readLinkObjectEndActionOfEnd, get_readLinkObjectEndQualifierActionOfQualifier, get_structuredClassifierOfOwnedAttribute, getAggregation, getAssociation, getAssociationEnd, getClassifier, getDatatype, getDefaultValue, getInterface, getOpposite, getOwningAssociation, getOwningSignal, getQualifier, getRedefinedProperty, getSubsettedProperty, getUMLClass, has_connectorEndOfPartWithPort, has_definedTaggedValue, has_interactionUseOfReturnValueRecipient, has_linkEndDataOfEnd, has_propertyOfRedefinedProperty, has_propertyOfSubsettedProperty, has_qualifierValueOfQualifier, has_readLinkObjectEndActionOfEnd, has_readLinkObjectEndQualifierActionOfQualifier, hasQualifier, hasRedefinedProperty, hasSubsettedProperty, isComposite, isDerived, isDerivedUnion, isID, isNavigable, set_artifactOfOwnedAttribute, set_associationOfNavigableOwnedEnd, set_structuredClassifierOfOwnedAttribute, setAggregation, setAssociation, setAssociationEnd, setClassifier, setDatatype, setDefaultValue, setDerived, setDerivedUnion, setID, setInterface, setOwningAssociation, setOwningSignal, setUMLClass
-
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.classes.mdkernel.StructuralFeature
get_slotOfDefiningFeature, get_structuralFeatureActionOfStructuralFeature, has_slotOfDefiningFeature, has_structuralFeatureActionOfStructuralFeature, isReadOnly, setReadOnly
-
Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.TypedElement
getType, setType
-
-
-
-
Method Detail
-
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:
setBehavior(boolean)
,com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getPort_Behavior()
- 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:
isBehavior()
- 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:
setConjugated(boolean)
,com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getPort_Conjugated()
- 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:
isConjugated()
- 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:
setService(boolean)
,com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getPort_Service()
- 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:
isService()
- Generated:
-
getRequired
java.util.Collection<Interface> getRequired()
Returns the value of the 'Required' reference list. The list contents are of typeInterface
. 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:
UMLPackage.getPort_Required()
,com.nomagic.uml2.ext.magicdraw.classes.mdinterfaces.Interface#get_portOfRequired
- Model:
- opposite="_portOfRequired" transient="true" changeable="false" volatile="true" derived="true" ordered="false"
- Generated:
-
get_invocationActionOfOnPort
java.util.Collection<InvocationAction> get_invocationActionOfOnPort()
Returns the value of the 'invocation Action Of On Port' reference list. The list contents are of typeInvocationAction
. 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:
UMLPackage.getPort__invocationActionOfOnPort()
,InvocationAction.getOnPort()
- 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:
setProtocol(ProtocolStateMachine)
,UMLPackage.getPort_Protocol()
,ProtocolStateMachine.get_portOfProtocol()
- 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:
getProtocol()
- Generated:
-
getProvided
java.util.Collection<Interface> getProvided()
Returns the value of the 'Provided' reference list. The list contents are of typeInterface
. 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:
UMLPackage.getPort_Provided()
,com.nomagic.uml2.ext.magicdraw.classes.mdinterfaces.Interface#get_portOfProvided
- Model:
- opposite="_portOfProvided" transient="true" changeable="false" volatile="true" derived="true" ordered="false"
- Generated:
-
getRedefinedPort
java.util.Collection<Port> getRedefinedPort()
Returns the value of the 'Redefined Port' reference list. The list contents are of typePort
. 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:
UMLPackage.getPort_RedefinedPort()
,get_portOfRedefinedPort()
- Model:
- opposite="_portOfRedefinedPort" ordered="false"
- Generated:
-
get_portOfRedefinedPort
java.util.Collection<Port> get_portOfRedefinedPort()
Returns the value of the 'port Of Redefined Port' reference list. The list contents are of typePort
. 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:
UMLPackage.getPort__portOfRedefinedPort()
,getRedefinedPort()
- Model:
- opposite="redefinedPort" ordered="false"
- Generated:
-
get_triggerOfPort
java.util.Collection<Trigger> get_triggerOfPort()
Returns the value of the 'trigger Of Port' reference list. The list contents are of typeTrigger
. 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:
UMLPackage.getPort__triggerOfPort()
,Trigger.getPort()
- 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:
-
-