Interface CLPort

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, CLConnectAbleElement, CLDeclarationAble, CLDeploymentTarget, CLFeature, CLProperty, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELFeature, ELMultiplicityAble, ELMultiplicityAbleTypedElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELProperty, ELRedefAble, ELStructFeature, ELTypedElement, ELUUIDAble, ELValueContainerAble, ELViewNavigAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface CLPort
extends CLProperty

A port is a property of a classifier that specifies a distinct interaction point between that classifier and its environment or between the (behavior of the) classifier and its internal parts. Ports are connected to properties of the classifier by connectors which requests can be made through to invoke the behavioral features of a classifier. A Port may specify the services a classifier provides (offers) to its environment as well as the services that a classifier expects (requires) of its environment.

See Also:

• CLPortHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CLPort.VAttr

Method Summary

Modifier and Type	Method	Description
<T extends ANInvocation> List<T>	getInvocation(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Invocation actions invoked by port.
SMProtocolStateMachine	getProtocol()	All protocol state machines using this port.
List<CLInterface>	getProvidedInterface(K_CONTROL_OPTION... behaviourFlags)	References the interfaces specifying the set of operations and receptions that the classifier 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.
List<CLInterface>	getProvidedInterface(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getProvidedInterface and filters its return values according to the given stereotype value.
List<CLInterface>	getRequiredInterface(K_CONTROL_OPTION... behaviourFlags)	References the interfaces specifying the set of operations and receptions that the classifier expects its environment to handle via this port.
List<CLInterface>	getRequiredInterface(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getRequiredInterface and filters its return values according to the given stereotype value.
boolean	isBehavior()	Specifies whether requests arriving at this port are sent to the classifier behavior of this classifier (see 'BehavioredClassifier (from BasicBehaviors)' on page 383).
boolean	isConjugated()	Specifies the way that the provided and required interfaces are derived from this port's type.
boolean	isService()	If true, indicates that this port is used to provide the published functionality of a classifier.
void	setBehavior(boolean value)	Set the value of Attribut IsBehavior.
void	setConjugated(boolean value)	Set the value of Attribut IsConjugated.
void	setInvocation(List<? extends ANInvocation> values)	Set the value of Foreign Key Invocation.
void	setService(boolean value)	Set the value of Attribut IsService.

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface CLConnectAbleElement

getBindingRole, getConnectedLifeline, getConnectedLifeline, getEnd, getLifeline, getSupplierRoleBinding

Methods inherited from interface CLDeploymentTarget

getDeployment

Methods inherited from interface CLProperty

associateProperty, getArtifact, getDataType, getInterface, getLinkAction, getLinkAction, getLinkEndData, getModifyPropertyDeclaration, getOperation, getOwnClass, getOwningAssociation, getOwningClassifier, getOwningSignal, getOwningStructuredClassifier, getPortOfPart, getPropertySlot, getQualifier, getQualifierValue, getTypingClassifier, modifyPropertyDeclaration

Methods inherited from interface ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface ELFeature

getEntryInGroupAble, getEntryInGroupAble, getUsingViewElement, isStatic, setStatic

Methods inherited from interface ELMultiplicityAble

getLower, getLowerBoundAsString, getLowerUpperVal, getUpper, getUpperBoundAsString, hasMultiplicity11, hasUpper1, isMany, isMultivalued, isOptional, isOrdered, isUnique, setLower, setMany, setOptional, setOrdered, setUnique, setUpper

Methods inherited from interface ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELProperty

getAggregation, getAssociation, getClassifierOfAssociationEnd, getDefaultValue, getOppositeAssociationEnd, getSelfAndSubsettedTransitive, getSelfAndSubsettedTransitive, getSelfAndSubsettingTransitive, getSelfAndSubsettingTransitive, getSubsettedProperty, getSubsettedTransitive, getSubsettedTransitive, getSubsettingProperty, getSubsettingTransitive, getSubsettingTransitive, isAssocOwner, isComposite, isDerived, isDerivedUnion, isNavigable, isNavigableAssocEnd, isSubsetted, isSubsetting, reconnectAssociation, setAggregation, setAssocOwner, setDefaultValue, setDerived, setDerivedUnion, setNavigableAssocEnd, setSubsettedProperty

Methods inherited from interface ELRedefAble

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

Methods inherited from interface ELStructFeature

getSlot, getStructuralFeatureAction, isReadOnly, setReadOnly

Methods inherited from interface ELTypedElement

getModifyTypedElementDeclaration, getType, getTypedElementCnstr, getTypeKind, getValSpecOfTypedElement, getValSpecOfTypedElementWithPattern, getValSpecOfTypedElementWithPattern, isBitmapAble, isColorAble, modifyTypedElementDeclaration, setType

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface ELViewNavigAble

getViewNavigAbleGroup

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MENamespaceAsgnAble

getSignatureMessage

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, 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, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

isBehavior

boolean isBehavior()
            throws InoNetException,
SrvErrorException

Specifies whether requests arriving at this port are sent to the classifier behavior of this classifier (see 'BehavioredClassifier (from BasicBehaviors)' on page 383). Such ports are referred to as behavior ports. Any invocation of a behavioral feature targeted at a behavior port will be handled by the instance of the owning classifier itself rather than by any instances that this classifier may contain. The default value is false.

Throws:

InoNetException

SrvErrorException

setBehavior

void setBehavior(boolean value)
          throws InoNetException,
SrvErrorException

Set the value of Attribut IsBehavior.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isService

boolean isService()
           throws InoNetException,
SrvErrorException

If true, indicates that this port is used to provide the published functionality of a classifier. If false, this port is used to implement the classifier but is not part of the essential externally- visible functionality of the classifier and can, therefore, be altered or deleted along with the internal implementation of the classifier and other properties that are considered part of its implementation. The default value for this attribute is true.

Throws:

InoNetException

SrvErrorException

setService

void setService(boolean value)
         throws InoNetException,
SrvErrorException

Set the value of Attribut IsService.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isConjugated

boolean isConjugated()
              throws InoNetException,
SrvErrorException

Specifies the way that the provided and required interfaces are derived from this port's type. The default value is false.

Throws:

InoNetException

SrvErrorException

setConjugated

void setConjugated(boolean value)
            throws InoNetException,
SrvErrorException

Set the value of Attribut IsConjugated.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getProvidedInterface

List<CLInterface> getProvidedInterface(K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

References the interfaces specifying the set of operations and receptions that the classifier 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.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted

getProvidedInterface

List<CLInterface> getProvidedInterface(MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

The method calls getProvidedInterface 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

getRequiredInterface

List<CLInterface> getRequiredInterface(K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

References the interfaces specifying the set of operations and receptions that the classifier 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.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted

getRequiredInterface

List<CLInterface> getRequiredInterface(MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

The method calls getRequiredInterface 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

getProtocol

SMProtocolStateMachine getProtocol()
                            throws InoNetException,
SrvErrorException

All protocol state machines using this port.

Throws:

InoNetException

SrvErrorException

getInvocation

<T extends ANInvocation> List<T> getInvocation(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
SrvErrorException

Invocation actions invoked by port.

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

setInvocation

void setInvocation(List<? extends ANInvocation> values)
            throws InoNetException,
SrvErrorException

Set the value of Foreign Key Invocation.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException