Package com.ptc.core.query.report.bom.server

Interface Reportable

public interface Reportable
Encapsulates any relational/tabular report generating object which takes simple string parameters and locale and produces a Swing TableModel of results.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    TableModel
    execute(Properties reportParams, Locale locale)
    Produces a Swing TableModel of report results using the given input arguments.
    Map
    getMetadata()
    Returns a Map from metadata names to values for the given report object.

  • Method Details

    • execute

      TableModel execute(Properties reportParams, Locale locale) throws WTException
      Produces a Swing TableModel of report results using the given input arguments.

      Supported API: true
      Parameters:
      reportParams - Report input parameters as name/value string pairs.
      locale - Locale to produce results in. Wherever possible the results should be locale independent, however.
      Returns:
      Swing TableModel containing the results
      Throws:
      WTException - Thrown upon any checked exception.

    • getMetadata

      Map getMetadata() throws WTException
      Returns a Map from metadata names to values for the given report object.

      Supported API: true
      Returns:
      Map of metadata name/value pairs. Lazy implementations can return null.
      Throws:
      WTException - Thrown upon any checked exception.