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

com.change_vision.jude.api.inf.model.IERDomain

All Superinterfaces:

IElement, IEntity, IHyperlinkOwner, INamedElement

All Implemented Interfaces:

IElement, IEntity, IHyperlinkOwner, INamedElement

public IERDomain
extends INamedElement

Interface for ERDomain.

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 IERDomain[]	getChildren() Get child domains.
abstract String	getDatatypeName() Get Datatype name.
abstract String	getDefaultValue() Get Default Value.
abstract String	getLengthPrecision() Get Length/Precision.
abstract String	getLogicalName() Get Logical Name.
abstract String	getPhysicalName() Get Physical Name.
abstract boolean	isNotNull() Check if the domain is NOT NULL.
abstract void	setDatatype(IERDatatype datatype) Set Datatype.
abstract void	setDefaultValue(String defaultValue) Set Default Value.
abstract void	setLengthPrecision(String value) Set Length and Precision.
abstract void	setLogicalName(String name) Set logical name to ER Domain.
abstract void	setNotNull(boolean isNotNull) Set Not Null.
abstract void	setParentDomain(IERDomain parentDomain) Set Parent Domain.
abstract void	setPhysicalName(String name) Set physical name to ER Domain.

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, 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

getLogicalName

abstract String getLogicalName()

Get Logical Name.

Returns:

Logical Name.

getPhysicalName

abstract String getPhysicalName()

Get Physical Name.

Returns:

Physical Name. Return an empty string in case there is none.

getDatatypeName

abstract String getDatatypeName()

Get Datatype name.

Returns:

Datatype name.

getDefaultValue

abstract String getDefaultValue()

Get Default Value.

Returns:

Default Value. Return an empty string in case there is none.

getLengthPrecision

abstract String getLengthPrecision()

Get Length/Precision.

Returns:

Length/Precision. Return an empty string in case there is none.

isNotNull

abstract boolean isNotNull()

Check if the domain is NOT NULL.

Returns:

true it is NOT NULL / false it is not NOT NULL

getChildren

abstract IERDomain[] getChildren()

Get child domains.

Returns:

the array of child domains. Return the empty array if there is none.

setLogicalName

abstract void setLogicalName(String name)

Set logical name to ER Domain.

Parameters:

name - Logical Name for ER Domain, should NOT be null

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.
      NAME_DOUBLE_ERROR_KEY  - An element with the same name already exists.
      NO_NAME_ERROR_KEY - if the name is empty.
      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.

setPhysicalName

abstract void setPhysicalName(String name)

Set physical name to ER Domain.

Parameters:

name - Physical Name for ER Domain

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.
      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.

setDatatype

abstract void setDatatype(IERDatatype datatype)

Set Datatype.

Parameters:

datatype - Datatype. It should not be null.

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.

setLengthPrecision

abstract void setLengthPrecision(String value)

Set Length and Precision.

Parameters:

value - Length and Precision:

 value "10"   : Length 10
 value "10,5" : Length 10, Precision 5
 To set Length and Precision, Datatype option for Length and Precision is referred.
     None : value should NOT be set.
     Optional : value is optional.
     Required : value is required. It should NOT be null.

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.

setNotNull

abstract void setNotNull(boolean isNotNull)

Set Not Null.

Parameters:

isNotNull - true to set Not Null constraint, false to set Not Null constraint.

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community.
      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.

setDefaultValue

abstract void setDefaultValue(String defaultValue)

Set Default Value.

Parameters:

defaultValue - Default Value. It should NOT be null.

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.

setParentDomain

abstract void setParentDomain(IERDomain parentDomain)

Set Parent Domain.

Parameters:

parentDomain - Parent Domain. It can be null.

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.