com.change_vision.jude.api.inf.model
Interface IPort

com.change_vision.jude.api.inf.model.IPort

All Superinterfaces:

IAttribute, IElement, IEntity, IHyperlinkOwner, INamedElement

All Implemented Interfaces:

IAttribute, IElement, IEntity, IHyperlinkOwner, INamedElement

public IPort
extends IAttribute

ポートに対するインターフェース。 Interface for Port.

Field Summary

Fields inherited from class com.change_vision.jude.api.inf.model.INamedElement

PACKAGE_VISIBILITY, PRIVATE_VISIBILITY, PROTECTED_VISIBILITY, PUBLIC_VISIBILITY

Method Summary

abstract IConnector[]	getConnectors() Get connectors.
abstract IItemFlow[]	getItemFlows() Get item flows.
abstract IClass[]	getProvidedInterfaces() Get all provided interfaces connected to this port.
abstract IClass[]	getRequiredInterfaces() Get all required interfaces connected to this port.
abstract boolean	isBehavior() Check if the port is a behavior.
abstract boolean	isConjugated() Check if the port is a conjugate port.
abstract boolean	isService() Check if the port is a service.
abstract void	setIsBehavior(boolean isBehavior) Set behavior to port.
abstract void	setIsConjugated(boolean isConjugated) Set conjugate to port.
abstract void	setIsService(boolean isService) Set service to port.

Methods inherited from class com.change_vision.jude.api.inf.model.IAttribute

getAssociation, getConnectors, getInitialValue, getMultiplicity, getNavigability, getQualifiedTypeExpression, getQualifiers, getType, getTypeExpression, isAggregate, isChangeable, isComposite, isDerived, isEnable, isStatic, setAggregation, setAggregationKind, setChangeable, setComposite, setDerived, setEnable, setInitialValue, setMultiplicity, setMultiplicityStrings, setNavigability, setQualifiedTypeExpression, setStatic, setType, setTypeExpression

Methods inherited from class com.change_vision.jude.api.inf.model.INamedElement

getClientDependencies, getClientRealizations, getClientUsages, getConstraints, getDefinition, getDiagrams, getFullName, getFullNamespace, getName, getSupplierDependencies, getSupplierRealizations, getSupplierUsages, isPackageVisibility, isPrivateVisibility, isProtectedVisibility, isPublicVisibility, setDefinition, setName, setVisibility

Methods inherited from class com.change_vision.jude.api.inf.model.IElement

addStereotype, getComments, getContainer, getContainers, getId, getOwner, getPresentations, getStereotypes, getTaggedValues, getTypeModifier, hasStereotype, hasStereotype, isReadOnly, removeStereotype, setTypeModifier

Methods inherited from class com.change_vision.jude.api.inf.model.IHyperlinkOwner

createElementHyperlink, createFileHyperlink, createURLHyperlink, deleteHyperlink, getHyperlinks

Method Detail

isService

abstract boolean isService()

Check if the port is a service.

Returns:

true true it is a service / false it is not a service

setIsService

abstract void setIsService(boolean isService)

Set service to port.

Parameters:

isService - if true, it is service, otherwise, it is not service.

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys: 
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred. 
      READ_ONLY_KEY - if a read-only element is edited.

Values: 
      Error messages for exceptions.

isBehavior

abstract boolean isBehavior()

Check if the port is a behavior.

Returns:

true true it is a behavior / false it is not a behavior

setIsBehavior

abstract void setIsBehavior(boolean isBehavior)

Set behavior to port.

Parameters:

isService - if true, it is behavior, otherwise, it is not behavior.

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys: 
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred. 
      READ_ONLY_KEY - if a read-only element is edited.

Values: 
      Error messages for exceptions.

isConjugated

abstract boolean isConjugated()

Check if the port is a conjugate port.

Returns:

true it is a conjugate port / false it is not a conjugate port

setIsConjugated

abstract void setIsConjugated(boolean isConjugated)

Set conjugate to port.

Parameters:

isConjugated - if true, it is conjugate port, otherwise, it is not conjugate port.

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys: 
      ILLEGAL_VERSION_ERROR_KEY - astah* communityで編集APIを使用しようとした場合 
      BAD_TRANSACTION_KEY - トランザクションエラー 
      HAS_EXCEPTION_KEY - 例外が発生した場合 
      READ_ONLY_KEY -  リードオンリーな要素を編集しようとした場合

Values: 
      例外のエラーメッセージ

Keys: 
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred. 
      READ_ONLY_KEY - if a read-only element is edited.

Values: 
      Error messages for exceptions.

getRequiredInterfaces

abstract IClass[] getRequiredInterfaces()

Get all required interfaces connected to this port.

Returns:

Required Interfaces connected to this port

getProvidedInterfaces

abstract IClass[] getProvidedInterfaces()

Get all provided interfaces connected to this port.

Returns:

Provided Interfaces connected to this port

getConnectors

abstract IConnector[] getConnectors()

Get connectors.

Returns:

the array of Connectors (Return the empty array in case there is no connectors).

getItemFlows

abstract IItemFlow[] getItemFlows()

Get item flows.

Returns:

the array of Item Flows (Return the empty array in case there is no item flows).