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

com.change_vision.jude.api.inf.model.IElement
All Known Implementing Classes:
INamedElement, ITaggedValue

public IElement

Interface for elements.


Method Summary
abstract  void addStereotype(String stereotype)
          Add a stereotype.
abstract  IComment[] getComments()
          Get Comments.
abstract  String getId()
          Get ID.
abstract  IElement getOwner()
          Get Namespace.
abstract  String[] getStereotypes()
          Get Stereotypes.
abstract  ITaggedValue[] getTaggedValues()
          Get Tagged Values.
abstract  String getTypeModifier()
          Get Type Modifier.
abstract  boolean isReadOnly()
          Check if this element is read only.
abstract  void removeStereotype(String stereotype)
          Remove a stereotype.
abstract  void setTypeModifier(String typeModifier)
          Set Type Modifier.
 

Method Detail

getId

public abstract String getId()
Get ID.

Returns:
ID.

getOwner

public abstract IElement getOwner()
Get Namespace.

Returns:
Namespace. Return null in case there is none.

getComments

public abstract IComment[] getComments()
Get Comments.

Returns:
The array of Comments. Return the empty array if there is none.

getStereotypes

public abstract String[] getStereotypes()
Get Stereotypes.

Returns:
The array of stereotypes. Return the empty array if there is none.

removeStereotype

public abstract void removeStereotype(String stereotype)
Remove a stereotype.

Parameters:
stereotype - Stereotype
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. 
      PARAMETER_ERROR_KEY - if a parameter is not set properly. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred.
Values: 
      Error messages for exceptions.

addStereotype

public abstract void addStereotype(String stereotype)
Add a stereotype.

Parameters:
stereotype - Stereotype
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. 
      PARAMETER_ERROR_KEY - if a parameter is not set properly. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred.
Values: 
      Error messages for exceptions.

getTaggedValues

public abstract ITaggedValue[] getTaggedValues()
Get Tagged Values.

Returns:
the array of Tagged Values. Return the empty array if there is none.

isReadOnly

public abstract boolean isReadOnly()
Check if this element is read only.

Returns:
true the element is read only / false the element is not read only

getTypeModifier

public abstract String getTypeModifier()
Get Type Modifier.

Returns:
Type Modifier.

setTypeModifier

public abstract void setTypeModifier(String typeModifier)
Set Type Modifier.

Parameters:
typeModifier - Type Modifier
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used Iin JUDE/Community.
      INVALID_TYPE_MODIFIER_MODEL_ERROR_KEY - if a Type Modifier cannot be set to the model.
      BAD_TRANSACTION_KEY - Bad Transaction.
      HAS_EXCEPTION_KEY - if an exception has occurred.
Values:
      Error messages for exceptions.