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

com.change_vision.jude.api.inf.model.IERSubtypeRelationship
All Implemented Interfaces:
IElement, IHyperlinkOwner, INamedElement

public IERSubtypeRelationship
extends INamedElement

Interface for ERSubtypeRelationship.


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  IEREntity getChild()
          Get Child Entity.
abstract  IERAttribute getDiscriminatorAttribute()
          Get Identifier Attribute.
abstract  IERAttribute[] getForeignKeys()
          Get foreign keys.
abstract  String getLogicalName()
          Get Logical Name.
abstract  IEREntity getParent()
          Get Parent Entity.
abstract  String getPhysicalName()
          Get Physical Name.
abstract  boolean isConclusive()
          Check if the relationship is Conclusive.
abstract  void setConclusive(boolean isConclusive)
          Set Conclusive.
abstract  void setDiscriminatorAttribute(IERAttribute discriminatorAttribute)
          Set Discriminator Attribute.
abstract  void setLogicalName(String name)
          Set Logical Name.
abstract  void setPhysicalName(String name)
          Set Physical Name.
 
Methods inherited from class com.change_vision.jude.api.inf.model.INamedElement
getAlias1, getAlias2, getClientDependencies, getConstraints, getDefinition, getDiagrams, getName, getSupplierDependencies, isPackageVisibility, isPrivateVisibility, isProtectedVisibility, isPublicVisibility, setAlias1, setAlias2, setDefinition, setName, setVisibility
 
Methods inherited from class com.change_vision.jude.api.inf.model.IElement
addStereotype, getComments, getId, getOwner, getStereotypes, getTaggedValues, getTypeModifier, isReadOnly, removeStereotype, setTypeModifier
 
Methods inherited from class com.change_vision.jude.api.inf.model.IHyperlinkOwner
createElementHyperlink, createFileHyperlink, createURLHyperlink, deleteHyperlink, getHyperlinks
 

Method Detail

getLogicalName

public abstract String getLogicalName()
Get Logical Name.

Returns:
Logical Name.

getPhysicalName

public abstract String getPhysicalName()
Get Physical Name.

Returns:
Physical Name. Return null in case there is none.

getDiscriminatorAttribute

public abstract IERAttribute getDiscriminatorAttribute()
Get Identifier Attribute.

Returns:
Identifier Attribute. Return null in case there is none.

isConclusive

public abstract boolean isConclusive()
Check if the relationship is Conclusive.

Returns:
true it is Conclusive / false it is not Conclusive

getParent

public abstract IEREntity getParent()
Get Parent Entity.

Returns:
Parent Entity.

getChild

public abstract IEREntity getChild()
Get Child Entity.

Returns:
Child Entity.

getForeignKeys

public abstract IERAttribute[] getForeignKeys()
Get foreign keys.

Returns:
the array of foreign keys. Return the empty array if there is none.

setLogicalName

public abstract void setLogicalName(String name)
Set Logical Name.

Parameters:
name - Logical Name. should NOT be null
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. 
      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.
Values: 
      Error messages for exceptions.

setPhysicalName

public abstract void setPhysicalName(String name)
Set Physical Name.

Parameters:
name - Logical Name.
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. 
      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.
Values: 
      Error messages for exceptions.

setDiscriminatorAttribute

public abstract void setDiscriminatorAttribute(IERAttribute discriminatorAttribute)
Set Discriminator Attribute.

Parameters:
discriminatorAttribute - Discriminator Attribute, should NOT be null
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. 
      ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred.
Values: 
      Error messages for exceptions.

setConclusive

public abstract void setConclusive(boolean isConclusive)
Set Conclusive.

Parameters:
isConclusive - if true, it is conclusive, otherwise, it is not conclusive.
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred.
Values: 
      Error messages for exceptions.