Package org.eclipse.epf.uma

Interface BreakdownElement

All Superinterfaces:
Classifier, DescribableElement, Element, org.eclipse.emf.ecore.EObject, MethodElement, NamedElement, org.eclipse.emf.common.notify.Notifier, PackageableElement, ProcessElement, Type
All Known Subinterfaces:
Activity, CapabilityPattern, CompositeRole, DeliveryProcess, Descriptor, Iteration, Milestone, Phase, Process, ProcessComponentDescriptor, ProcessComponentInterface, ProcessPlanningTemplate, RoleDescriptor, TaskDescriptor, TeamProfile, WorkBreakdownElement, WorkProductDescriptor
All Known Implementing Classes:
ActivityImpl, BreakdownElementImpl, CapabilityPatternImpl, CompositeRoleImpl, DeliveryProcessImpl, DescriptorImpl, IterationImpl, MilestoneImpl, PhaseImpl, ProcessComponentDescriptorImpl, ProcessComponentInterfaceImpl, ProcessImpl, ProcessPlanningTemplateImpl, RoleDescriptorImpl, TaskDescriptorImpl, TeamProfileImpl, WorkBreakdownElementImpl, WorkProductDescriptorImpl
public interface BreakdownElement
extends ProcessElement
A representation of the model object 'Breakdown Element'. Breakdown Element is an abstract generalization for any type of Method Element that is part of a breakdown structure. It defines a set of properties available to all of its specializations.

The following features are supported:

See Also:
UmaPackage.getBreakdownElement()

  • Method Details

    • getPrefix

      java.lang.String getPrefix()
      Returns the value of the 'Prefix' attribute. The default value is "". Prefix represents an additional label that will be presented as a prefix to any Breakdown Element to indicate a user-defined sub-type for the element. For example, if the process engineer would like to distinguish his Activities by 'Module' (as done in the IBM Rational Summit Ascendant Method), he can define a different prefix for every model to be used in addition to naming Activities, e.g. "SRA.Establish Requirements" with SRA indicating that this Activity belongs to the "Software Requirements Analysis" module. Another common application for prefix is to qualify roles in Role Descriptors. For example, "Customer.Architect" would define a "Customer" prefix for the Role Descriptor "Architect" expressing that this is an architect on the customer side and not the development team side.
      Returns:
      the value of the 'Prefix' attribute.
      See Also:
      setPrefix(String), UmaPackage.getBreakdownElement_Prefix()

    • setPrefix

      void setPrefix​(java.lang.String value)
      Sets the value of the 'Prefix' attribute.
      Parameters:
      value - the new value of the 'Prefix' attribute.
      See Also:
      getPrefix()

    • getIsPlanned

      java.lang.Boolean getIsPlanned()
      Returns the value of the 'Is Planned' attribute. The default value is "true". A key application for Development Processes expressed with Breakdown structures is to generate a project plan from it. A process as defined in UMA (cf. with Sections XX and 5.2) is a multi-dimensional structure defining what work is being performed at what time by which roles using which input and producing what outputs. A project plan as it is represented in project planning tools such as IBM Rational Portfolio Manager or Microsoft Project normally does not need all this information and is normally limited to just representing a subset. For example, a typical MS Project plan only represents the work breakdown consisting of Tasks and Activities (sometimes referred to as summary tasks). It does not show the input and output Work Products for a Task, but it can show which roles shall be staffed for performing the Task. However, such role allocation need to be replaced with concrete resources when instantiating the plan for a concrete project. Sometimes project plans can then again be organized differently by organizing work by deliverables in which Work Products are mapped to the plan's summary tasks and Task that have these work products as output mapped below such as summary task. Therefore, a process can make recommendations about which elements to include and which to exclude when generating a plan. When the isPlanned attribute is set to False for an instance of a Breakdown Element, then this element shall not be not included when a concrete project plan is being generated from the breakdown structure that contains this element.
      Returns:
      the value of the 'Is Planned' attribute.
      See Also:
      setIsPlanned(Boolean), UmaPackage.getBreakdownElement_IsPlanned()

    • setIsPlanned

      void setIsPlanned​(java.lang.Boolean value)
      Sets the value of the 'Is Planned' attribute.
      Parameters:
      value - the new value of the 'Is Planned' attribute.
      See Also:
      getIsPlanned()

    • getHasMultipleOccurrences

      java.lang.Boolean getHasMultipleOccurrences()
      Returns the value of the 'Has Multiple Occurrences' attribute. The default value is "false". Just as the isPlanned attribute the hasMultipleOccurrences attribute has an impact on generating plans from a Process. When this attribute is set to True for a Breakdown Element then it will typically occur multiple times within the same Activity. For example, a Task such as "Detail Use Case" would be performed for every use case identified for a particular Iteration or Activity. Generating a plan would list one Task instance per use case.
      Returns:
      the value of the 'Has Multiple Occurrences' attribute.
      See Also:
      setHasMultipleOccurrences(Boolean), UmaPackage.getBreakdownElement_HasMultipleOccurrences()

    • setHasMultipleOccurrences

      void setHasMultipleOccurrences​(java.lang.Boolean value)
      Sets the value of the 'Has Multiple Occurrences' attribute.
      Parameters:
      value - the new value of the 'Has Multiple Occurrences' attribute.
      See Also:
      getHasMultipleOccurrences()

    • getIsOptional

      java.lang.Boolean getIsOptional()
      Returns the value of the 'Is Optional' attribute. The default value is "false". The isOptional attribute indicates that the Breakdown Element describes work, a work result, or even work resources, which inclusion is not mandatory when performing a project that is planned based on a process containing this element.
      Returns:
      the value of the 'Is Optional' attribute.
      See Also:
      setIsOptional(Boolean), UmaPackage.getBreakdownElement_IsOptional()

    • setIsOptional

      void setIsOptional​(java.lang.Boolean value)
      Sets the value of the 'Is Optional' attribute.
      Parameters:
      value - the new value of the 'Is Optional' attribute.
      See Also:
      getIsOptional()

    • getPresentedAfter

      BreakdownElement getPresentedAfter()
      Returns the value of the 'Presented After' reference.
      Returns:
      the value of the 'Presented After' reference.
      See Also:
      setPresentedAfter(BreakdownElement), UmaPackage.getBreakdownElement_PresentedAfter()

    • setPresentedAfter

      void setPresentedAfter​(BreakdownElement value)
      Sets the value of the 'Presented After' reference.
      Parameters:
      value - the new value of the 'Presented After' reference.
      See Also:
      getPresentedAfter()

    • getPresentedBefore

      BreakdownElement getPresentedBefore()
      Returns the value of the 'Presented Before' reference.
      Returns:
      the value of the 'Presented Before' reference.
      See Also:
      setPresentedBefore(BreakdownElement), UmaPackage.getBreakdownElement_PresentedBefore()

    • setPresentedBefore

      void setPresentedBefore​(BreakdownElement value)
      Sets the value of the 'Presented Before' reference.
      Parameters:
      value - the new value of the 'Presented Before' reference.
      See Also:
      getPresentedBefore()

    • getPlanningData

      PlanningData getPlanningData()
      Returns the value of the 'Planning Data' containment reference.
      Returns:
      the value of the 'Planning Data' containment reference.
      See Also:
      setPlanningData(PlanningData), UmaPackage.getBreakdownElement_PlanningData()

    • setPlanningData

      void setPlanningData​(PlanningData value)
      Sets the value of the 'Planning Data' containment reference.
      Parameters:
      value - the new value of the 'Planning Data' containment reference.
      See Also:
      getPlanningData()

    • getSuperActivities

      Activity getSuperActivities()
      Returns the value of the 'Super Activities' reference. It is bidirectional and its opposite is 'Breakdown Elements'.
      Returns:
      the value of the 'Super Activities' reference.
      See Also:
      setSuperActivities(Activity), UmaPackage.getBreakdownElement_SuperActivities(), Activity.getBreakdownElements()

    • setSuperActivities

      void setSuperActivities​(Activity value)
      Sets the value of the 'Super Activities' reference.
      Parameters:
      value - the new value of the 'Super Activities' reference.
      See Also:
      getSuperActivities()

    • getChecklists

      org.eclipse.emf.common.util.EList<Checklist> getChecklists()
      Returns the value of the 'Checklists' reference list. The list contents are of type Checklist.
      Returns:
      the value of the 'Checklists' reference list.
      See Also:
      UmaPackage.getBreakdownElement_Checklists()

    • getConcepts

      org.eclipse.emf.common.util.EList<Concept> getConcepts()
      Returns the value of the 'Concepts' reference list. The list contents are of type Concept.
      Returns:
      the value of the 'Concepts' reference list.
      See Also:
      UmaPackage.getBreakdownElement_Concepts()

    • getExamples

      org.eclipse.emf.common.util.EList<Example> getExamples()
      Returns the value of the 'Examples' reference list. The list contents are of type Example.
      Returns:
      the value of the 'Examples' reference list.
      See Also:
      UmaPackage.getBreakdownElement_Examples()

    • getGuidelines

      org.eclipse.emf.common.util.EList<Guideline> getGuidelines()
      Returns the value of the 'Guidelines' reference list. The list contents are of type Guideline.
      Returns:
      the value of the 'Guidelines' reference list.
      See Also:
      UmaPackage.getBreakdownElement_Guidelines()

    • getReusableAssets

      org.eclipse.emf.common.util.EList<ReusableAsset> getReusableAssets()
      Returns the value of the 'Reusable Assets' reference list. The list contents are of type ReusableAsset.
      Returns:
      the value of the 'Reusable Assets' reference list.
      See Also:
      UmaPackage.getBreakdownElement_ReusableAssets()

    • getSupportingMaterials

      org.eclipse.emf.common.util.EList<SupportingMaterial> getSupportingMaterials()
      Returns the value of the 'Supporting Materials' reference list. The list contents are of type SupportingMaterial.
      Returns:
      the value of the 'Supporting Materials' reference list.
      See Also:
      UmaPackage.getBreakdownElement_SupportingMaterials()

    • getTemplates

      org.eclipse.emf.common.util.EList<Template> getTemplates()
      Returns the value of the 'Templates' reference list. The list contents are of type Template.
      Returns:
      the value of the 'Templates' reference list.
      See Also:
      UmaPackage.getBreakdownElement_Templates()

    • getReports

      org.eclipse.emf.common.util.EList<Report> getReports()
      Returns the value of the 'Reports' reference list. The list contents are of type Report.
      Returns:
      the value of the 'Reports' reference list.
      See Also:
      UmaPackage.getBreakdownElement_Reports()

    • getEstimationconsiderations

      org.eclipse.emf.common.util.EList<EstimationConsiderations> getEstimationconsiderations()
      Returns the value of the 'Estimationconsiderations' reference list. The list contents are of type EstimationConsiderations.
      Returns:
      the value of the 'Estimationconsiderations' reference list.
      See Also:
      UmaPackage.getBreakdownElement_Estimationconsiderations()

    • getToolmentor

      org.eclipse.emf.common.util.EList<ToolMentor> getToolmentor()
      Returns the value of the 'Toolmentor' reference list. The list contents are of type ToolMentor.
      Returns:
      the value of the 'Toolmentor' reference list.
      See Also:
      UmaPackage.getBreakdownElement_Toolmentor()