com.change_vision.jude.api.stpa.model
Interface IIdentifiedElement

com.change_vision.jude.api.stpa.model.IIdentifiedElement
All Superinterfaces:
IElement, IEntity, IHyperlinkOwner, IStampElement
All Implemented Interfaces:
IElement, IEntity, IHyperlinkOwner, IStampElement
All Known Implementing Classes:
IAccident, ICountermeasure, IHazard, IHazardCausalFactor, IHazardScenario, IPrecondition, ISafetyConstraint, IUnsafeControlAction

public abstract IIdentifiedElement
extends IHyperlinkOwner, IStampElement

Interface for Identified Element.


Method Summary
abstract  String getDescription()
          Get Description
abstract  String getIdentifier()
          Get Identifier
abstract  void setDescription(String description)
          Set Description
abstract  void setIdentifier(String identifier)
          Set Identifier
 
Methods inherited from class com.change_vision.jude.api.inf.model.IHyperlinkOwner
createElementHyperlink, createFileHyperlink, createURLHyperlink, deleteHyperlink, getHyperlinks
 
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
 

Method Detail

getIdentifier

abstract String getIdentifier()
Get Identifier

Returns:
String ID

setIdentifier

abstract void setIdentifier(String identifier)
Set Identifier

Parameters:
identifier - ID
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       READ_ONLY_KEY - if a read-only element is edited.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

getDescription

abstract String getDescription()
Get Description

Returns:
String Description

setDescription

abstract void setDescription(String description)
Set Description

Parameters:
description - Description
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       READ_ONLY_KEY - if a read-only element is edited.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.