Interface DescribableElement

All Superinterfaces:
Classifier, Element, org.eclipse.emf.ecore.EObject, MethodElement, NamedElement, org.eclipse.emf.common.notify.Notifier, PackageableElement, Type
All Known Subinterfaces:
Activity, Artifact, BreakdownElement, CapabilityPattern, Checklist, CompositeRole, Concept, ContentCategory, ContentElement, CustomCategory, Deliverable, DeliveryProcess, Descriptor, Discipline, DisciplineGrouping, Domain, EstimationConsiderations, Example, FulfillableElement, Guidance, Guideline, Iteration, Kind, Milestone, Outcome, Phase, PlanningData, Practice, Process, ProcessComponentDescriptor, ProcessComponentInterface, ProcessElement, ProcessPlanningTemplate, Report, ReusableAsset, Roadmap, Role, RoleDescriptor, RoleSet, RoleSetGrouping, SupportingMaterial, Task, TaskDescriptor, TeamProfile, Template, TermDefinition, Tool, ToolMentor, Whitepaper, WorkBreakdownElement, WorkOrder, WorkProduct, WorkProductDescriptor, WorkProductType
All Known Implementing Classes:
ActivityImpl, ArtifactImpl, BreakdownElementImpl, CapabilityPatternImpl, ChecklistImpl, CompositeRoleImpl, ConceptImpl, ContentCategoryImpl, ContentElementImpl, CustomCategoryImpl, DeliverableImpl, DeliveryProcessImpl, DescribableElementImpl, DescriptorImpl, DisciplineGroupingImpl, DisciplineImpl, DomainImpl, EstimationConsiderationsImpl, ExampleImpl, FulfillableElementImpl, GuidanceImpl, GuidelineImpl, IterationImpl, KindImpl, MilestoneImpl, OutcomeImpl, PhaseImpl, PlanningDataImpl, PracticeImpl, ProcessComponentDescriptorImpl, ProcessComponentInterfaceImpl, ProcessElementImpl, ProcessImpl, ProcessPlanningTemplateImpl, ReportImpl, ReusableAssetImpl, RoadmapImpl, RoleDescriptorImpl, RoleImpl, RoleSetGroupingImpl, RoleSetImpl, SupportingMaterialImpl, TaskDescriptorImpl, TaskImpl, TeamProfileImpl, TemplateImpl, TermDefinitionImpl, ToolImpl, ToolMentorImpl, WhitepaperImpl, WorkBreakdownElementImpl, WorkOrderImpl, WorkProductDescriptorImpl, WorkProductImpl, WorkProductTypeImpl

public interface DescribableElement
extends MethodElement, Classifier
A representation of the model object 'Describable Element'. Describable Element is an abstract generalization of Method Elements for which external presentation names as well as content descriptions have been defined, such as Roles or Work Products. Presentation Name and Content Descriptions are typically localized using a resource allocation mechanism for its String type attributes. This abstraction represents all elements in the Method Content as well as Process space for which concrete textual descriptions are defined in the form of documenting attributes grouped in a matching Content Description instance (see Section 4.1.4). Describable Elements are intended to be published in method or process publications (similar to the IBM Rational Unified Process web). Describable Element defines that the element it represents will have content 'attached' to it. Content Description is the abstraction for the actual places in which the content is being represented. This separation allows a distinction between core method model elements describing the structure of the model from the actual description container providing, for example, the documentation of the content element in different alternatives languages, audiences, licensing levels, etc. This definition of Content Element extends the Content Element definition via package merge with references to icons that are used for presenting Content Elements in a UMA-based modeling environment as well as when publishing Content Elements into documentation presentation (e.g. document or html pages).

The following features are supported:

See Also:
UmaPackage.getDescribableElement()
  • Method Details

    • getPresentation

      ContentDescription getPresentation()
      Returns the value of the 'Presentation' containment reference.
      Returns:
      the value of the 'Presentation' containment reference.
      See Also:
      setPresentation(ContentDescription), UmaPackage.getDescribableElement_Presentation()
    • setPresentation

      void setPresentation​(ContentDescription value)
      Sets the value of the 'Presentation' containment reference.
      Parameters:
      value - the new value of the 'Presentation' containment reference.
      See Also:
      getPresentation()
    • getShapeicon

      java.net.URI getShapeicon()
      Returns the value of the 'Shapeicon' attribute. A reference to an icon that can be used for modeling with specific Content Element instances (as graphical stereotypes, e.g. a use case symbol for a use case artifact) as well as publication of content.
      Returns:
      the value of the 'Shapeicon' attribute.
      See Also:
      setShapeicon(URI), UmaPackage.getDescribableElement_Shapeicon()
    • setShapeicon

      void setShapeicon​(java.net.URI value)
      Sets the value of the 'Shapeicon' attribute.
      Parameters:
      value - the new value of the 'Shapeicon' attribute.
      See Also:
      getShapeicon()
    • getNodeicon

      java.net.URI getNodeicon()
      Returns the value of the 'Nodeicon' attribute. A reference to an icon that can be used in tree browser presentations and breakdown structures.
      Returns:
      the value of the 'Nodeicon' attribute.
      See Also:
      setNodeicon(URI), UmaPackage.getDescribableElement_Nodeicon()
    • setNodeicon

      void setNodeicon​(java.net.URI value)
      Sets the value of the 'Nodeicon' attribute.
      Parameters:
      value - the new value of the 'Nodeicon' attribute.
      See Also:
      getNodeicon()