IEnumeration

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 IEnumeration

com.change_vision.jude.api.inf.model.IEnumeration

All Superinterfaces:: IClass, IDataType, IElement, IEntity, IHyperlinkOwner, INamedElement

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

All Known Implementing Classes:: IEnumerationValueType

public abstract IEnumeration
extends IDataType
extends IDataType

Interface for enumerations.

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 IEnumerationLiteral`	`createEnumerationLiteral(String name)` Create an EnumerationLiteral in an Enumeration.
`abstract IEnumerationLiteral[]`	`getEnumerationLiterals()` Get EnumerationLiterals.

Methods inherited from class com.change_vision.jude.api.inf.model.IClass
`getAttributes, getGeneralizations, getNestedClasses, getOperations, getPorts, getSpecializations, getTemplateBindings, getTemplateParameters, isAbstract, isActive, isLeaf, isPrimitiveType, setAbstract, setActive, setLeaf`

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

getEnumerationLiterals

abstract IEnumerationLiteral[] getEnumerationLiterals()

Get EnumerationLiterals.

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

createEnumerationLiteral

abstract IEnumerationLiteral createEnumerationLiteral(String name)

Create an EnumerationLiteral in an Enumeration.

Parameters:

name - EnumerationLiteral Name

Returns:

IEnumerationLiteral EnumerationLiteral

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.
       READ_ONLY_KEY - if a read-only element is edited.

Values:
       Error messages for exceptions.