Package org.eclipse.epf.uma

Interface ContentDescription

All Superinterfaces:
Element, org.eclipse.emf.ecore.EObject, MethodElement, MethodUnit, NamedElement, org.eclipse.emf.common.notify.Notifier, PackageableElement
All Known Subinterfaces:
ActivityDescription, ArtifactDescription, BreakdownElementDescription, DeliverableDescription, DeliveryProcessDescription, DescriptorDescription, GuidanceDescription, PracticeDescription, ProcessDescription, RoleDescription, TaskDescription, WorkProductDescription
All Known Implementing Classes:
ActivityDescriptionImpl, ArtifactDescriptionImpl, BreakdownElementDescriptionImpl, ContentDescriptionImpl, DeliverableDescriptionImpl, DeliveryProcessDescriptionImpl, DescriptorDescriptionImpl, GuidanceDescriptionImpl, PracticeDescriptionImpl, ProcessDescriptionImpl, RoleDescriptionImpl, TaskDescriptionImpl, WorkProductDescriptionImpl
public interface ContentDescription
extends MethodUnit
A representation of the model object 'Content Description'. Content Description is a Method Element that is used to store the textual description for a Content Element. It defines standard attributes applicable for all Content Element types. Specific Content Element sub-types can define their own matching Content Description sub-types.

The following features are supported:

See Also:
UmaPackage.getContentDescription()

  • Method Details

    • getMainDescription

      java.lang.String getMainDescription()
      Returns the value of the 'Main Description' attribute. The default value is "". This attribute store the main descriptive text for the Content Element. All text that is not part of any of the more specific attributes shall be stored here. If the Content Description is divided into sections using the Section class, then only the text from the 'start' of the content description to the first section will be stored here (similar to a normal document where you can place text between its beginning to its first diction heading).
      Returns:
      the value of the 'Main Description' attribute.
      See Also:
      setMainDescription(String), UmaPackage.getContentDescription_MainDescription()

    • setMainDescription

      void setMainDescription​(java.lang.String value)
      Sets the value of the 'Main Description' attribute.
      Parameters:
      value - the new value of the 'Main Description' attribute.
      See Also:
      getMainDescription()

    • getSections

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

    • getExternalId

      java.lang.String getExternalId()
      Returns the value of the 'External Id' attribute. The default value is "". An external visible number or label that is used to reference this element. Used like a synonym to the name.
      Returns:
      the value of the 'External Id' attribute.
      See Also:
      setExternalId(String), UmaPackage.getContentDescription_ExternalId()

    • setExternalId

      void setExternalId​(java.lang.String value)
      Sets the value of the 'External Id' attribute.
      Parameters:
      value - the new value of the 'External Id' attribute.
      See Also:
      getExternalId()

    • getKeyConsiderations

      java.lang.String getKeyConsiderations()
      Returns the value of the 'Key Considerations' attribute. The default value is "". Key Considerations provides advise and guidance of a critical nature for the content element as well as warnings, cautions, pitfalls, dangers.
      Returns:
      the value of the 'Key Considerations' attribute.
      See Also:
      setKeyConsiderations(String), UmaPackage.getContentDescription_KeyConsiderations()

    • setKeyConsiderations

      void setKeyConsiderations​(java.lang.String value)
      Sets the value of the 'Key Considerations' attribute.
      Parameters:
      value - the new value of the 'Key Considerations' attribute.
      See Also:
      getKeyConsiderations()

    • getLongPresentationName

      java.lang.String getLongPresentationName()
      Returns the value of the 'Long Presentation Name' attribute.
      Returns:
      the value of the 'Long Presentation Name' attribute.
      See Also:
      setLongPresentationName(String), UmaPackage.getContentDescription_LongPresentationName()

    • setLongPresentationName

      void setLongPresentationName​(java.lang.String value)
      Sets the value of the 'Long Presentation Name' attribute.
      Parameters:
      value - the new value of the 'Long Presentation Name' attribute.
      See Also:
      getLongPresentationName()