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

com.change_vision.jude.api.inf.model.INamedElement
All Superinterfaces:
IElement, IEntity, IHyperlinkOwner
All Implemented Interfaces:
IElement, IEntity, IHyperlinkOwner
All Known Implementing Classes:
IAction, IActivity, IActivityDiagram, IActivityNode, IActivityParameterNode, IAnchor, IArtifact, IAssociation, IAssociationClass, IAttribute, IClass, IClassDiagram, IClassifierTemplateParameter, ICombinedFragment, IComment, ICommunicationDiagram, IComponent, IComponentDiagram, ICompositeStructureDiagram, IConnector, IConstraint, IControlNode, IDataFlow, IDataFlowDiagram, IDataFlowNode, IDataStore, IDependency, IDeploymentDiagram, IDiagram, IDurationConstraint, IERAttribute, IERDatatype, IERDiagram, IERDomain, IEREntity, IERIndex, IERModel, IERRelationship, IERSchema, IERSubtypeRelationship, IExtend, IExtentionPoint, IExternalEntity, IFinalState, IFlow, IGate, IGeneralization, IInclude, IInputPin, IInstanceSpecification, IInteraction, IInteractionFragment, IInteractionOperand, IInteractionUse, ILifeline, ILifelineLink, ILink, ILinkEnd, IMatrixDiagram, IMessage, IMindMapDiagram, IModel, INode, IObjectNode, IOperation, IOutputPin, IPackage, IParameter, IPartition, IPin, IPort, IProcessBox, IPseudostate, IRealization, IRequirement, IRequirementDiagram, IRequirementTable, ISequenceDiagram, ISlot, IState, IStateInvariant, IStateMachine, IStateMachineDiagram, ISubsystem, ITemplateBinding, ITermination, ITestCase, ITimeConstraint, ITraceabilityMap, ITransition, IUsage, IUseCase, IUseCaseDiagram, IVertex

public INamedElement
extends IElement, IHyperlinkOwner

Interface for named elements.


Field Summary
(package private) static String PACKAGE_VISIBILITY
           
(package private) static String PRIVATE_VISIBILITY
           
(package private) static String PROTECTED_VISIBILITY
           
(package private) static String PUBLIC_VISIBILITY
           
 
Method Summary
abstract  String getAlias1()
          Get Alias1.
abstract  String getAlias2()
          Get Alias2.
abstract  IDependency[] getClientDependencies()
          Get Client Dependencies.
abstract  IRealization[] getClientRealizations()
          Get Realizations.
abstract  IUsage[] getClientUsages()
          Get Usages.
abstract  IConstraint[] getConstraints()
          Get Constraints.
abstract  String getDefinition()
          Get Definition.
abstract  IDiagram[] getDiagrams()
          Get Diagrams.
abstract  String getFullName(String namespaceSeparator)
          Get Name with Full Namespace.
abstract  String getFullNamespace(String namespaceSeparator)
          Get Full Namespace of Element.
abstract  String getName()
          Get Name.
abstract  IDependency[] getSupplierDependencies()
          Get Supplier Dependencies.
abstract  IRealization[] getSupplierRealizations()
          Get Supplier Realizations.
abstract  IUsage[] getSupplierUsages()
          Get Supplier Usages.
abstract  boolean isPackageVisibility()
          Check if the visibility is Package.
abstract  boolean isPrivateVisibility()
          Check if the visibility is Private.
abstract  boolean isProtectedVisibility()
          Check if the visibility is Protected.
abstract  boolean isPublicVisibility()
          Check if the visibility is Public.
abstract  void setAlias1(String alias1)
          Set Alias1.
abstract  void setAlias2(String alias2)
          Set Alias2.
abstract  void setDefinition(String definition)
          Set Definition.
abstract  void setName(String name)
          Set Name.
abstract  void setVisibility(String visibility)
          Set Visibility.
 
Methods inherited from class com.change_vision.jude.api.inf.model.IElement
addStereotype, getComments, getContainer, getContainers, getId, getOwner, getPresentations, getStereotypes, getTaggedValues, getTypeModifier, hasStereotype, hasStereotype, isReadOnly, removeStereotype, setTypeModifier
 
Methods inherited from class com.change_vision.jude.api.inf.model.IHyperlinkOwner
createElementHyperlink, createFileHyperlink, createURLHyperlink, deleteHyperlink, getHyperlinks
 

Field Detail

PUBLIC_VISIBILITY

static final String PUBLIC_VISIBILITY

PROTECTED_VISIBILITY

static final String PROTECTED_VISIBILITY

PACKAGE_VISIBILITY

static final String PACKAGE_VISIBILITY

PRIVATE_VISIBILITY

static final String PRIVATE_VISIBILITY
Method Detail

getName

abstract String getName()
Get Name.

Returns:
Name

getConstraints

abstract IConstraint[] getConstraints()
Get Constraints.

Returns:
the array of Constraints.

getSupplierDependencies

abstract IDependency[] getSupplierDependencies()
Get Supplier Dependencies.

Returns:
the array of Dependency.

getSupplierRealizations

abstract IRealization[] getSupplierRealizations()
Get Supplier Realizations.

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

getSupplierUsages

abstract IUsage[] getSupplierUsages()
Get Supplier Usages.

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

getClientDependencies

abstract IDependency[] getClientDependencies()
Get Client Dependencies.

Returns:
the array of Dependency.

getClientRealizations

abstract IRealization[] getClientRealizations()
Get Realizations.

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

getClientUsages

abstract IUsage[] getClientUsages()
Get Usages.

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

getDefinition

abstract String getDefinition()
Get Definition.

Returns:
String definition

isPublicVisibility

abstract boolean isPublicVisibility()
Check if the visibility is Public.

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

isProtectedVisibility

abstract boolean isProtectedVisibility()
Check if the visibility is Protected.

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

isPrivateVisibility

abstract boolean isPrivateVisibility()
Check if the visibility is Private.

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

isPackageVisibility

abstract boolean isPackageVisibility()
Check if the visibility is Package.

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

getDiagrams

abstract IDiagram[] getDiagrams()
Get Diagrams.

Returns:
the array of Diagrams.

setName

abstract void setName(String name)
Set Name.

Parameters:
name - Name
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.

setDefinition

abstract void setDefinition(String definition)
Set Definition.

Parameters:
definition - Definition
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.

setVisibility

abstract void setVisibility(String visibility)
Set Visibility.

Parameters:
visibility: - public, protected, package, private visibility: public, protected, package, private
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.

getAlias1

abstract String getAlias1()
Get Alias1.

Returns:
Alias1

getAlias2

abstract String getAlias2()
Get Alias2.

Returns:
Alias2

setAlias1

abstract void setAlias1(String alias1)
Set Alias1. Alias1 can be deleted by null.

Parameters:
alias1 - alias1
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community. 
      INVALID_ALIAS_MODEL_ERROR_KEY - if an alias cannot be set to the model. 
      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.

setAlias2

abstract void setAlias2(String alias2)
Set Alias2. Alias2 can be deleted by null.

Parameters:
alias2 - alias2
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community. 
      INVALID_ALIAS_MODEL_ERROR_KEY - if an alias cannot be set to the model. 
      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.

getFullName

abstract String getFullName(String namespaceSeparator)
Get Name with Full Namespace. Add the namespaces from the top to IElement#getOwner(), and name of the element.

Parameters:
namespaceSeparator - Separator of the namespace (e.g. "::", "/", ".")
Returns:
String of the name with the namespaces
Since:
6.6.4
See Also:
getFullNamespace(String), IElement.getOwner()

getFullNamespace

abstract String getFullNamespace(String namespaceSeparator)
Get Full Namespace of Element. Add the namespaces from the top to IElement#getOwner(). The name of the element is not included.

Parameters:
namespaceSeparator - Separator of the namespace (e.g. "::", "/", ".")
Returns:
String of the namespaces (e.g. "com::change_vision::jude::api::inf::model")
Since:
6.6.4
See Also:
IElement.getOwner()