Traceability

ttm
Interface HierarchicalElement

All Superinterfaces:
AttributeOwner, Element, EObject, IdentifiedElement, Notifier
All Known Subinterfaces:
Document, Requirement, Section
All Known Implementing Classes:
DocumentImpl, HierarchicalElementImpl, RequirementImpl, SectionImpl

public interface HierarchicalElement
extends IdentifiedElement

A representation of the model object 'Hierarchical Element'.

The following features are supported:

See Also:
TtmPackage.getHierarchicalElement()
** Generated **
Model:
abstract="true"

Method Summary
 EList getChildren()
          Returns the value of the 'Children' containment reference list.
 java.util.List<CoverLink> getCoverLinks()
          Returns the value of the 'Cover Link' containment reference list.
 Document getDocument()
          Returns the value of the 'Parent document'
 EList getIncomingNavigationLinks()
          Returns the value of the 'Incoming Navigation Links' reference list.
 EList getNavigationLinks()
          Returns the value of the 'Navigation Links' containment reference list.
 HierarchicalElement getParent()
          Returns the value of the 'Parent' container reference.
 java.lang.Boolean isCoveringElementID(java.lang.String identifier)
          Returns if the requirement is covering the element which identifier is in parameter.
 java.lang.Boolean isMacroRequirement()
          Indicates if the element is a requirement that contains other requirements
 void setParent(HierarchicalElement value)
          Sets the value of the 'Parent' container reference
 
Methods inherited from interface ttm.IdentifiedElement
getIdent, getShortDescription, getTexts, setIdent, setShortDescription
 
Methods inherited from interface ttm.AttributeOwner
getAttributes
 
Methods inherited from interface ttm.Element
getActivatedRules
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getIncomingNavigationLinks

EList getIncomingNavigationLinks()
Returns the value of the 'Incoming Navigation Links' reference list. The list contents are of type NavigationLink. It is bidirectional and its opposite is 'To'.

If the meaning of the 'Incoming Navigation Links' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Incoming Navigation Links' reference list.
See Also:
TtmPackage.getHierarchicalElement_IncomingNavigationLinks(), NavigationLink.getTo()
** Generated **
Model:
type="ttm.NavigationLink" opposite="to"

getNavigationLinks

EList getNavigationLinks()
Returns the value of the 'Navigation Links' containment reference list. The list contents are of type NavigationLink. It is bidirectional and its opposite is 'From'.

If the meaning of the 'Navigation Links' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Navigation Links' containment reference list.
See Also:
TtmPackage.getHierarchicalElement_NavigationLinks(), NavigationLink.getFrom()
** Generated **
Model:
type="ttm.NavigationLink" opposite="from" containment="true"

getChildren

EList getChildren()
Returns the value of the 'Children' containment reference list. The list contents are of type HierarchicalElement. It is bidirectional and its opposite is 'Parent'.

If the meaning of the 'Children' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Children' containment reference list.
See Also:
TtmPackage.getHierarchicalElement_Children(), getParent()
** Generated **
Model:
type="ttm.HierarchicalElement" opposite="parent" containment="true"

getCoverLinks

java.util.List<CoverLink> getCoverLinks()
Returns the value of the 'Cover Link' containment reference list. The list contents are of type CoverLink. It is bidirectional and its opposite is 'From'.

If the meaning of the 'Cover Link' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Cover Link' containment reference list.
See Also:
ttm.TtmPackage#getHierarchicalElement_CoverLink(), CoverLink.getFrom()
** Generated **
NOT
Model:
type="ttm.CoverLink" opposite="from" containment="true"

getParent

HierarchicalElement getParent()
Returns the value of the 'Parent' container reference. It is bidirectional and its opposite is 'Children'.

If the meaning of the 'Parent' container reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Parent' container reference.
See Also:
setParent(HierarchicalElement), TtmPackage.getHierarchicalElement_Parent(), getChildren()
** Generated **
Model:
opposite="children"

getDocument

Document getDocument()
Returns the value of the 'Parent document'.

when parent is a Document it will be returned, else we will call getParent() while it is not a Document.

Specified by:
getDocument in interface Element
Returns:
the value of the 'Parent document'.
See Also:
TtmPackage.getHierarchicalElement_Parent()

setParent

void setParent(HierarchicalElement value)
Sets the value of the 'Parent' container reference.

Parameters:
value - the new value of the 'Parent' container reference.
See Also:
getParent()
** Generated **

isMacroRequirement

java.lang.Boolean isMacroRequirement()
Indicates if the element is a requirement that contains other requirements.

Returns:
if the element is a requirement that contains requirements

isCoveringElementID

java.lang.Boolean isCoveringElementID(java.lang.String identifier)
Returns if the requirement is covering the element which identifier is in parameter.

Returns:
if the requirement is covering the element which identifier is in parameter

Traceability

Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.