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

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

public abstract IUnit
extends IInstanceSpecification

Interface for Units.


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  String getDefinitionURI()
          Get definition URI.
abstract  String getDescription()
          Get description.
abstract  IQuantityKind getQuantityKind()
          Not implemented yet. Get QuantityKind.
abstract  String getSymbol()
          Get symbol.
abstract  void setDefinitionURI(String definitionURI)
          Set definition URI.
abstract  void setDescription(String description)
          Set description.
abstract  void setQuantityKind(IQuantityKind quantityKind)
          Not implemented yet. Set QuantityKind.
abstract  void setSymbol(String symbol)
          Set symbol.
 
Methods inherited from class com.change_vision.jude.api.inf.model.IInstanceSpecification
getAllResidents, getAllSlots, getClassifier, getContainer, getContainers, getLinkEnds, getSlot, setClassifier
 
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

getQuantityKind

abstract IQuantityKind getQuantityKind()
Not implemented yet. Get QuantityKind.

Returns:
QuantityKind property. Return null in case no QuantityKind is set.

setQuantityKind

abstract void setQuantityKind(IQuantityKind quantityKind)
Not implemented yet. Set QuantityKind.

Parameters:
quantityKind - quantityKind
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.
       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.

getSymbol

abstract String getSymbol()
Get symbol.

Returns:
Symbol. Return empty string in case no symbol is found.

setSymbol

abstract void setSymbol(String symbol)
Set symbol.

Parameters:
symbol - symbol
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.
       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.

getDefinitionURI

abstract String getDefinitionURI()
Get definition URI.

Returns:
Definition URI. Return empty string in case no definition URI is found.

setDefinitionURI

abstract void setDefinitionURI(String definitionURI)
Set definition URI.

Parameters:
definitionURI - definitionURI
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.
       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.

getDescription

abstract String getDescription()
Get description.

Returns:
Description. Return empty string in case no description is found.

setDescription

abstract void setDescription(String description)
Set description.

Parameters:
description - description
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.
       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.