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

com.change_vision.jude.api.inf.model.IItemFlow
All Superinterfaces:
IConnector, IElement, IEntity, IHyperlinkOwner, INamedElement
All Implemented Interfaces:
IConnector, IElement, IEntity, IHyperlinkOwner, INamedElement

public abstract IItemFlow
extends IConnector

Interface for ItemFlows.


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  void addConvey(IClass convey)
          Add Convey.
abstract  IClass[] getConveys()
          Get conveys.
abstract  IAttribute getItemProperty()
          Get Item Property.
abstract  void removeConvey(IClass convey)
          Remove Convey.
 
Methods inherited from class com.change_vision.jude.api.inf.model.IConnector
getParts, getPartsWithPort, getPorts, getType
 
Methods inherited from class com.change_vision.jude.api.inf.model.INamedElement
getAlias1, getAlias2, getClientDependencies, getClientRealizations, getClientUsages, getConstraints, getDefinition, getDiagrams, getFullName, getFullNamespace, getName, getSupplierDependencies, getSupplierRealizations, getSupplierUsages, isPackageVisibility, isPrivateVisibility, isProtectedVisibility, isPublicVisibility, setAlias1, setAlias2, setDefinition, setName, setVisibility
 
Methods inherited from class com.change_vision.jude.api.inf.model.IElement
addStereotype, getComments, getContainer, getContainers, getId, getOwner, getPresentations, getStereotypes, getTaggedValue, getTaggedValues, getTypeModifier, hasStereotype, isReadOnly, removeStereotype, setTypeModifier
 
Methods inherited from class com.change_vision.jude.api.inf.model.IHyperlinkOwner
createElementHyperlink, createFileHyperlink, createURLHyperlink, deleteHyperlink, getHyperlinks
 

Method Detail

getItemProperty

abstract IAttribute getItemProperty()
Get Item Property.

Returns:
Item Property. Return null in case no item property is found.

getConveys

abstract IClass[] getConveys()
Get conveys.

Returns:
the array of conveys (Return the empty array in case there is no conveys).

addConvey

abstract void addConvey(IClass convey)
Add Convey.

Parameters:
convey - Convey to add.
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in Astah community.
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal.
       NAME_DOUBLE_ERROR_KEY - An element with the same name already exists.
       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.

removeConvey

abstract void removeConvey(IClass convey)
Remove Convey.

Parameters:
convey - Convey to remove
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in Astah community.
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal.
       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.