IInformationFlow

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

com.change_vision.jude.api.inf.model.IInformationFlow

All Superinterfaces:: IElement, IEntity, IHyperlinkOwner, INamedElement

All Implemented Interfaces:: IElement, IEntity, IHyperlinkOwner, INamedElement

All Known Implementing Classes:: IItemFlow

public abstract IInformationFlow
extends INamedElement
extends INamedElement

Interface for InformationFlows.

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`	`addConveyed(IClass conveyed)` Add Conveyed.
`abstract IClass[]`	`getConveyeds()` Get conveyed Classes.
`abstract INamedElement`	`getInformationSource()` Get Information Source.
`abstract INamedElement`	`getInformationTarget()` Get Information Target.
`abstract IConnector`	`getRealizingConnector()` Get realizing Connector.
`abstract void`	`removeConveyed(IClass conveyed)` Remove Conveyed.

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

getInformationSource

abstract INamedElement getInformationSource()

Get Information Source.

Returns:: the information source

getInformationTarget

abstract INamedElement getInformationTarget()

Get Information Target.

Returns:: the information target

getConveyeds

abstract IClass[] getConveyeds()

Get conveyed Classes.

Returns:: the array of conveyed Class. Return the empty array in case there is none.

addConveyed

abstract void addConveyed(IClass conveyed)

Add Conveyed.

Parameters:

conveyed - the conveyed Class. If the item is already conveyed by the InformationFlow, it will not be added again.

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.

removeConveyed

abstract void removeConveyed(IClass conveyed)

Remove Conveyed.