Package com.polarion.alm.builder.model

Interface ICalculationDescriptor

All Known Subinterfaces:
ICustomCalculationDescriptor, ISiteCalculationDescriptor
public interface ICalculationDescriptor
Calculation descriptor.

Kind of "abstract" interface - nothing implements it directly.

Version:
$Revision$ $Date$
Author:
Stepan Roh, Polarion Software
See Also:

  • Method Details

    • getName

      String getName()
      Build name.
      Returns:
      build name (not null)

    • getDescription

      String getDescription()
      Arbitrary, human-readable description (if any).
      Returns:
      description or null

    • getGoals

      List getGoals()
      Maven 2 goals/phases to execute during calculation.

      What is executed if there are no goals specified depends on concrete subinterface.

      Returns:
      List of String goals/phases (not null)

    • getCalculationProperties

      Properties getCalculationProperties()
      Properties to use during calculation.

      System adds other properties defined in system-wide configuration.

      Returns:
      properties (not null)

    • isAggregation

      boolean isAggregation()
      Whether this is plain calculation or aggregation.

      This only influences which local deployment is used - IBuildArtifact.getResources() or IBuildArtifact.getAggregationResources() - and has no other meaning.

      It is safe to leave it at false, true should be used only if it is assured that aggregation resources are enough for executed reports (note that site calculation will most probably not work with aggregation-only resources).

      Returns:
      true if this is supposed to be aggregation, false otherwise

    • getExtendedDescriptors

      List getExtendedDescriptors()
      Descriptors which this descriptor extends.

      Note that nothing is guaranteed about returned descriptors - they may or may not exist, be of different type (site or custom), contain cycles, be doubled etc.

      Returns:
      List of String descriptor names (not null)

    • getCalculationReportDefinitions

      List getCalculationReportDefinitions()
      Calculation report definitions.

      Specifies how reports calculation should behave.

      Returns:
      List of ICalculationDescriptor.IReportDefinitions (not null)