Package org.eclipse.epf.uma

Interface Section

All Superinterfaces:
Element, org.eclipse.emf.ecore.EObject, MethodElement, NamedElement, org.eclipse.emf.common.notify.Notifier, PackageableElement, VariabilityElement
All Known Subinterfaces:
Step
All Known Implementing Classes:
SectionImpl, StepImpl
public interface Section
extends VariabilityElement
A representation of the model object 'Section'. A Section is a special Method Element that represents structural subsections of a Content Description's sectionDescription attribute. It is used for either large scale documentation of Content Elements organized into sections as well as to flexibly add new Sections to Content Elements using contribution variability added to the Section concept for Method Plug-ins. Section in the package Method Plugin inherits from Variability Element and extends Section defined in Method Core :: Basic Elements with new capabilities for variability. For example, when a Task contributes to another Task its Presentation association is contributed including its Sections (i.e. its Steps), which are modeled as parts of the Content Description instance. Sections can be nested and therefore Task Descriptions can be flexibly organized in Steps with sub-Steps. Sections are Variability Elements themselves, so they can contribute to each other. For example, one could model a Task step as a Section instance without relating it to a Task Description that directly contributes to (or replaces) another Section which is part of a Task Description. This contribution (or replacement) would add new description text to the original step description (or replace the original step description). Another example would be to contribute new Check List items organized as Sections to an existing Check List (defined as guidance).

The following features are supported:

See Also:
UmaPackage.getSection()

  • Method Details

    • getSectionName

      java.lang.String getSectionName()
      Returns the value of the 'Section Name' attribute. The default value is "". Every Section has a name used for external presentation of the section, e.g. when published or when section heading are listed in a table of contents. This attribute is similar to Presentation Name for Content Elements.
      Returns:
      the value of the 'Section Name' attribute.
      See Also:
      setSectionName(String), UmaPackage.getSection_SectionName()

    • setSectionName

      void setSectionName​(java.lang.String value)
      Sets the value of the 'Section Name' attribute.
      Parameters:
      value - the new value of the 'Section Name' attribute.
      See Also:
      getSectionName()

    • getSectionDescription

      java.lang.String getSectionDescription()
      Returns the value of the 'Section Description' attribute. The default value is "". This attributes store the description text for a Content Description's Section.
      Returns:
      the value of the 'Section Description' attribute.
      See Also:
      setSectionDescription(String), UmaPackage.getSection_SectionDescription()

    • setSectionDescription

      void setSectionDescription​(java.lang.String value)
      Sets the value of the 'Section Description' attribute.
      Parameters:
      value - the new value of the 'Section Description' attribute.
      See Also:
      getSectionDescription()

    • getSubSections

      org.eclipse.emf.common.util.EList<Section> getSubSections()
      Returns the value of the 'Sub Sections' containment reference list. The list contents are of type Section.
      Returns:
      the value of the 'Sub Sections' containment reference list.
      See Also:
      UmaPackage.getSection_SubSections()

    • getPredecessor

      Section getPredecessor()
      Returns the value of the 'Predecessor' reference.
      Returns:
      the value of the 'Predecessor' reference.
      See Also:
      setPredecessor(Section), UmaPackage.getSection_Predecessor()

    • setPredecessor

      void setPredecessor​(Section value)
      Sets the value of the 'Predecessor' reference.
      Parameters:
      value - the new value of the 'Predecessor' reference.
      See Also:
      getPredecessor()