ReportingDefinition (EBX® Add-ons Version 5.3.0 Java API)

java.lang.Object
- com.orchestranetworks.addon.dqid.ReportingDefinition

Direct Known Subclasses:

BigDataDefinition, FlatDataDefinition
```
public abstract class ReportingDefinition
extends Object
```
Declares associations between output parameters and reporting fields in the Flat data report table or the Big data report table of Insight - Reporting data sets.

Since:

2.0.0

See Also:

BigDataDefinition, FlatDataDefinition

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPathAssociation(com.orchestranetworks.schema.Path path, String parameterDefinitionName)` Adds an association between a `Path` and the name of an output `ParameterDefinition`.
`abstract com.orchestranetworks.schema.Path`	`getAutoEmailSentPath()` Returns the `Path` to the field indicating whether the automatic email is sent or not.
`abstract com.orchestranetworks.schema.Path`	`getDatasetPath()` Returns the `Path` to the field of the target data set.
`abstract com.orchestranetworks.schema.Path`	`getDataspacePath()` Returns the `Path` to the field of the target data space.
`abstract com.orchestranetworks.schema.Path`	`getDECCodePath()` Returns the `Path` to the field of the Data Element Concept's code.
`abstract com.orchestranetworks.schema.Path`	`getEmailOwnerPath()` Returns the `Path` to the field of the email owners.
`abstract com.orchestranetworks.schema.Path`	`getExecutionTimePath()` Returns the `Path` to the field of the execution time.
`abstract com.orchestranetworks.schema.Path`	`getExecutionUUIDPath()` Returns the `Path` to the field of the unique execution identifier.
`abstract com.orchestranetworks.schema.Path`	`getFieldCodePath()` Returns the `Path` to the field of the target field's code.
`abstract com.orchestranetworks.schema.Path`	`getFieldNamePath()` Returns the `Path` to the field of the target field's name.
`abstract com.orchestranetworks.schema.Path`	`getFieldPath()` Returns the `Path` to the field of the target field.
`abstract com.orchestranetworks.schema.Path`	`getFkDECPath()` Returns the `Path` to the field of the Data Element Concept foreign key.
`abstract com.orchestranetworks.schema.Path`	`getGroupCodePath()` Returns the `Path` to the field of the target group's code.
`abstract com.orchestranetworks.schema.Path`	`getGroupingFieldPath()` Returns the `Path` to the field of the target grouping field.
`abstract com.orchestranetworks.schema.Path`	`getGroupingValuePath()` Returns the `Path` to the field of the target grouping value.
`abstract com.orchestranetworks.schema.Path`	`getGroupNamePath()` Returns the `Path` to the field of the target group's name.
`abstract com.orchestranetworks.schema.Path`	`getGroupPath()` Returns the `Path` to the field of the target group.
`abstract com.orchestranetworks.schema.Path`	`getIndicatorCodePath()` Returns the `Path` to the field of the indicator's code.
`abstract com.orchestranetworks.schema.Path`	`getIndicatorNamePath()` Returns the `Path` to the field of the indicator's name.
`abstract com.orchestranetworks.schema.Path`	`getIntervalFormatPath()` Returns the `Path` to the field of the interval format.
`abstract com.orchestranetworks.schema.Path`	`getLanguagePath()` Returns the `Path` to the field of the language at execution time.
`abstract com.orchestranetworks.schema.Path`	`getLinkedRecordPath()` Returns the `Path` to the field of the linked records.
`abstract com.orchestranetworks.schema.Path`	`getMaxThresholdDecimalPath()` Returns the `Path` to the field of the decimal maximum threshold.
`abstract com.orchestranetworks.schema.Path`	`getMaxThresholdPath()` Returns the `Path` to the field of the integer maximum threshold.
`abstract com.orchestranetworks.schema.Path`	`getMinThresholdDecimalPath()` Returns the `Path` to the field of the decimal minimum threshold.
`abstract com.orchestranetworks.schema.Path`	`getMinThresholdPath()` Returns the `Path` to the field of the integer minimum threshold.
`abstract com.orchestranetworks.schema.Path`	`getOidPath()` Returns the `Path` to the identifier field of the table.
`abstract com.orchestranetworks.schema.Path`	`getOperationKeyPath()` Returns the `Path` to the field of the operation's key.
`abstract com.orchestranetworks.schema.Path`	`getOperationPath()` Returns the `Path` to the field of operations on indicator results, such as sending emails, ect.
`String`	`getParameterDefinitionNameForPath(com.orchestranetworks.schema.Path path)` Returns the output parameter name that matches a specific path.
`com.orchestranetworks.schema.Path`	`getPathForParameterDefinition(String parameterName)` Returns the reporting path of an output parameter.
`abstract com.orchestranetworks.schema.Path`	`getPeriodEndDatePath()` Returns the `Path` to the field of the period end date.
`abstract com.orchestranetworks.schema.Path`	`getPeriodicityOfControlLabelPath()` Returns the `Path` to the field of the periodicity of control's label.
`abstract com.orchestranetworks.schema.Path`	`getPeriodicityOfControlPath()` Returns the `Path` to the field of the periodicity of control.
`abstract com.orchestranetworks.schema.Path`	`getPeriodStartDatePath()` Returns the `Path` to the field of the period start date.
`abstract com.orchestranetworks.schema.Path`	`getRecordLinkPath()` Returns the `Path` to the field of the record link when an indicator is run in the real-time mode.
`abstract com.orchestranetworks.schema.Path`	`getRecordPredicatePath()` Returns the `Path` to the field of the record predicate when an indicator is run in the real-time mode.
`abstract com.orchestranetworks.schema.Path`	`getRemovedPath()` Returns the `Path` to the field indicating whether the current reporting record is considered removed.
`abstract com.orchestranetworks.schema.Path`	`getReportingTablePathInSchema()` Returns the `Path` to the current reporting table.
`abstract com.orchestranetworks.schema.Path`	`getSequenceNumberPath()` Returns the `Path` to the field of the sequence number.
`abstract com.orchestranetworks.schema.Path`	`getTableCodePath()` Returns the `Path` to the field of the target table's code.
`abstract com.orchestranetworks.schema.Path`	`getTableFilterPredicatePath()` Returns the `Path` to the field of the target table's filter predicate.
`abstract com.orchestranetworks.schema.Path`	`getTableLinkPath()` Returns the `Path` to the field of the target table's link.
`abstract com.orchestranetworks.schema.Path`	`getTableNamePath()` Returns the `Path` to the field of the target table's name.
`abstract com.orchestranetworks.schema.Path`	`getTablePath()` Returns the `Path` to the field of the target table.
`abstract com.orchestranetworks.schema.Path`	`getToleranceNumberPath()` Returns the `Path` to the field of the tolerance number.
`abstract com.orchestranetworks.schema.Path`	`getUserPath()` Returns the `Path` to the field of the user executed the indicator.
`abstract com.orchestranetworks.schema.Path`	`getValidityStatusPath()` Returns the `Path` to the field of the validity status.
`abstract com.orchestranetworks.schema.Path`	`getWatchdogIndicatorResultsPath()` Returns the `Path` to the field of the watchdog indicator results.
`abstract com.orchestranetworks.schema.Path`	`getWatchdogRaisedPath()` Returns the `Path` to the field indicating whether the default watchdog of an indicator is raised or not.
`abstract com.orchestranetworks.schema.Path`	`getWorkflowPublicationKeyPath()` Returns the `Path` to the field of the workflow publication's key.
`abstract com.orchestranetworks.schema.Path`	`getWorkflowPublicationNamePath()` Returns the `Path` to the field of the workflow publication's name.
`boolean`	`hasPath(com.orchestranetworks.schema.Path path)` Checks a path's existence in the `Big data report` table or the `Flat data report` table for the indicator.
`boolean`	`isAnalyticViewSupported()` Returns `true` if the indicator supports analytical views.
`boolean`	`isBarChartViewSupported()` Returns `true` if the indicator supports the bar chart.
`boolean`	`isDigitalChartViewSupported()` Returns `true` if the indicator supports the digital chart.
`abstract boolean`	`isFlatData()` Returns `true` if this class represents the `Flat data report` table.
`boolean`	`isPieChartViewSupported()` Returns `true` if the indicator supports the pie chart.
`Iterator<com.orchestranetworks.schema.Path>`	`iterator()` Returns an iterator over all the elements in the indicator's outcomes.
`void`	`setBarChartViewSupported(boolean barChartViewSupported)` Sets whether the indicator supports the bar chart view.
`void`	`setDigitalChartViewSupported(boolean digitalChartViewSupported)` Sets whether the indicator supports the digital chart view.
`void`	`setPieChartViewSupported(boolean pieChartViewSupported)` Sets whether the indicator supports the pie chart view.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isFlatData
```
public abstract boolean isFlatData()
```
    Returns true if this class represents the Flat data report table.
  - addPathAssociation
```
public final void addPathAssociation(com.orchestranetworks.schema.Path path,
                                     String parameterDefinitionName)
```
    Adds an association between a Path and the name of an output ParameterDefinition.
    
    Must be a path from either the Big data report table or the Flat data report table.
    
    Parameters:
    
    path - Path
    
    parameterDefinitionName - String
    
    Throws:
    
    IllegalArgumentException - If the output path or the output name is null or already exists.
  - getParameterDefinitionNameForPath
```
public final String getParameterDefinitionNameForPath(com.orchestranetworks.schema.Path path)
```
    Returns the output parameter name that matches a specific path.
    
    Parameters:
    
    path - Path
    
    Returns:
    
    String
  - getPathForParameterDefinition
```
public final com.orchestranetworks.schema.Path getPathForParameterDefinition(String parameterName)
```
    Returns the reporting path of an output parameter.
    
    Parameters:
    
    parameterName - String.
    
    Returns:
    
    Path
  - hasPath
```
public final boolean hasPath(com.orchestranetworks.schema.Path path)
```
    Checks a path's existence in the Big data report table or the Flat data report table for the indicator.
    
    Parameters:
    
    path - Path
  - iterator
```
public final Iterator<com.orchestranetworks.schema.Path> iterator()
```
    Returns an iterator over all the elements in the indicator's outcomes.
    
    Returns:
    
    Iterator<Path>.
  - setDigitalChartViewSupported
```
public final void setDigitalChartViewSupported(boolean digitalChartViewSupported)
```
    Sets whether the indicator supports the digital chart view.
    
    Note: Analytical view support has a higher priority than this view.
    
    Parameters:
    
    digitalChartViewSupported - boolean
    
    See Also:
    
    isAnalyticViewSupported()
  - setPieChartViewSupported
```
public final void setPieChartViewSupported(boolean pieChartViewSupported)
```
    Sets whether the indicator supports the pie chart view.
    
    Note: Analytical view support has a higher priority than this view.
    
    Parameters:
    
    pieChartViewSupported - boolean
    
    See Also:
    
    isAnalyticViewSupported()
  - setBarChartViewSupported
```
public final void setBarChartViewSupported(boolean barChartViewSupported)
```
    Sets whether the indicator supports the bar chart view.
    
    Note: Analytical view support has a higher priority than this view.
    
    Parameters:
    
    barChartViewSupported - boolean
    
    Since:
    
    2.0.0
    
    See Also:
    
    isAnalyticViewSupported()
  - isAnalyticViewSupported
```
public final boolean isAnalyticViewSupported()
```
    Returns true if the indicator supports analytical views.
    
    If this value is false then no other analytical view will be available, such as the pie chart view.
    
    Returns:
    
    boolean
  - isDigitalChartViewSupported
```
public final boolean isDigitalChartViewSupported()
```
    Returns true if the indicator supports the digital chart.
    
    Returns:
    
    boolean
    
    See Also:
    
    isAnalyticViewSupported()
  - isPieChartViewSupported
```
public final boolean isPieChartViewSupported()
```
    Returns true if the indicator supports the pie chart.
    
    Returns:
    
    boolean
    
    See Also:
    
    isAnalyticViewSupported()
  - isBarChartViewSupported
```
public final boolean isBarChartViewSupported()
```
    Returns true if the indicator supports the bar chart.
    
    Returns:
    
    boolean
    
    Since:
    
    2.0.0
    
    See Also:
    
    isAnalyticViewSupported()
  - getReportingTablePathInSchema
```
public abstract com.orchestranetworks.schema.Path getReportingTablePathInSchema()
```
    Returns the Path to the current reporting table.
    Either the Flat data report table or the Big data report table.
  - getOidPath
```
public abstract com.orchestranetworks.schema.Path getOidPath()
```
    Returns the Path to the identifier field of the table.
  - getExecutionUUIDPath
```
public abstract com.orchestranetworks.schema.Path getExecutionUUIDPath()
```
    Returns the Path to the field of the unique execution identifier.
  - getExecutionTimePath
```
public abstract com.orchestranetworks.schema.Path getExecutionTimePath()
```
    Returns the Path to the field of the execution time.
  - getSequenceNumberPath
```
public abstract com.orchestranetworks.schema.Path getSequenceNumberPath()
```
    Returns the Path to the field of the sequence number.
  - getWatchdogRaisedPath
```
public abstract com.orchestranetworks.schema.Path getWatchdogRaisedPath()
```
    Returns the Path to the field indicating whether the default watchdog of an indicator is raised or not.
  - getAutoEmailSentPath
```
public abstract com.orchestranetworks.schema.Path getAutoEmailSentPath()
```
    Returns the Path to the field indicating whether the automatic email is sent or not.
  - getLanguagePath
```
public abstract com.orchestranetworks.schema.Path getLanguagePath()
```
    Returns the Path to the field of the language at execution time.
  - getUserPath
```
public abstract com.orchestranetworks.schema.Path getUserPath()
```
    Returns the Path to the field of the user executed the indicator.
  - getEmailOwnerPath
```
public abstract com.orchestranetworks.schema.Path getEmailOwnerPath()
```
    Returns the Path to the field of the email owners.
  - getOperationPath
```
public abstract com.orchestranetworks.schema.Path getOperationPath()
```
    Returns the Path to the field of operations on indicator results, such as sending emails, ect.
  - getIndicatorCodePath
```
public abstract com.orchestranetworks.schema.Path getIndicatorCodePath()
```
    Returns the Path to the field of the indicator's code.
  - getIndicatorNamePath
```
public abstract com.orchestranetworks.schema.Path getIndicatorNamePath()
```
    Returns the Path to the field of the indicator's name.
  - getFkDECPath
```
public abstract com.orchestranetworks.schema.Path getFkDECPath()
```
    Returns the Path to the field of the Data Element Concept foreign key.
  - getDECCodePath
```
public abstract com.orchestranetworks.schema.Path getDECCodePath()
```
    Returns the Path to the field of the Data Element Concept's code.
  - getDataspacePath
```
public abstract com.orchestranetworks.schema.Path getDataspacePath()
```
    Returns the Path to the field of the target data space.
  - getDatasetPath
```
public abstract com.orchestranetworks.schema.Path getDatasetPath()
```
    Returns the Path to the field of the target data set.
  - getTablePath
```
public abstract com.orchestranetworks.schema.Path getTablePath()
```
    Returns the Path to the field of the target table.
  - getTableCodePath
```
public abstract com.orchestranetworks.schema.Path getTableCodePath()
```
    Returns the Path to the field of the target table's code.
  - getTableNamePath
```
public abstract com.orchestranetworks.schema.Path getTableNamePath()
```
    Returns the Path to the field of the target table's name.
  - getTableLinkPath
```
public abstract com.orchestranetworks.schema.Path getTableLinkPath()
```
    Returns the Path to the field of the target table's link.
  - getTableFilterPredicatePath
```
public abstract com.orchestranetworks.schema.Path getTableFilterPredicatePath()
```
    Returns the Path to the field of the target table's filter predicate.
  - getGroupPath
```
public abstract com.orchestranetworks.schema.Path getGroupPath()
```
    Returns the Path to the field of the target group.
  - getGroupCodePath
```
public abstract com.orchestranetworks.schema.Path getGroupCodePath()
```
    Returns the Path to the field of the target group's code.
  - getGroupNamePath
```
public abstract com.orchestranetworks.schema.Path getGroupNamePath()
```
    Returns the Path to the field of the target group's name.
  - getFieldPath
```
public abstract com.orchestranetworks.schema.Path getFieldPath()
```
    Returns the Path to the field of the target field.
  - getFieldCodePath
```
public abstract com.orchestranetworks.schema.Path getFieldCodePath()
```
    Returns the Path to the field of the target field's code.
  - getFieldNamePath
```
public abstract com.orchestranetworks.schema.Path getFieldNamePath()
```
    Returns the Path to the field of the target field's name.
  - getRecordPredicatePath
```
public abstract com.orchestranetworks.schema.Path getRecordPredicatePath()
```
    Returns the Path to the field of the record predicate when an indicator is run in the real-time mode.
  - getRecordLinkPath
```
public abstract com.orchestranetworks.schema.Path getRecordLinkPath()
```
    Returns the Path to the field of the record link when an indicator is run in the real-time mode.
  - getWorkflowPublicationNamePath
```
public abstract com.orchestranetworks.schema.Path getWorkflowPublicationNamePath()
```
    Returns the Path to the field of the workflow publication's name.
  - getWorkflowPublicationKeyPath
```
public abstract com.orchestranetworks.schema.Path getWorkflowPublicationKeyPath()
```
    Returns the Path to the field of the workflow publication's key.
  - getOperationKeyPath
```
public abstract com.orchestranetworks.schema.Path getOperationKeyPath()
```
    Returns the Path to the field of the operation's key.
  - getPeriodicityOfControlPath
```
public abstract com.orchestranetworks.schema.Path getPeriodicityOfControlPath()
```
    Returns the Path to the field of the periodicity of control.
  - getPeriodicityOfControlLabelPath
```
public abstract com.orchestranetworks.schema.Path getPeriodicityOfControlLabelPath()
```
    Returns the Path to the field of the periodicity of control's label.
  - getPeriodStartDatePath
```
public abstract com.orchestranetworks.schema.Path getPeriodStartDatePath()
```
    Returns the Path to the field of the period start date.
    
    Since:
    
    2.1.0
  - getPeriodEndDatePath
```
public abstract com.orchestranetworks.schema.Path getPeriodEndDatePath()
```
    Returns the Path to the field of the period end date.
    
    Since:
    
    2.1.0
  - getMinThresholdPath
```
public abstract com.orchestranetworks.schema.Path getMinThresholdPath()
```
    Returns the Path to the field of the integer minimum threshold.
  - getMaxThresholdPath
```
public abstract com.orchestranetworks.schema.Path getMaxThresholdPath()
```
    Returns the Path to the field of the integer maximum threshold.
  - getMinThresholdDecimalPath
```
public abstract com.orchestranetworks.schema.Path getMinThresholdDecimalPath()
```
    Returns the Path to the field of the decimal minimum threshold.
  - getMaxThresholdDecimalPath
```
public abstract com.orchestranetworks.schema.Path getMaxThresholdDecimalPath()
```
    Returns the Path to the field of the decimal maximum threshold.
  - getToleranceNumberPath
```
public abstract com.orchestranetworks.schema.Path getToleranceNumberPath()
```
    Returns the Path to the field of the tolerance number.
  - getValidityStatusPath
```
public abstract com.orchestranetworks.schema.Path getValidityStatusPath()
```
    Returns the Path to the field of the validity status.
  - getIntervalFormatPath
```
public abstract com.orchestranetworks.schema.Path getIntervalFormatPath()
```
    Returns the Path to the field of the interval format.
    
    See Also:
    
    IntervalType
  - getLinkedRecordPath
```
public abstract com.orchestranetworks.schema.Path getLinkedRecordPath()
```
    Returns the Path to the field of the linked records.
    
    See Also:
    
    LinkedRecordDefinition, LinkedRecordInformation
  - getWatchdogIndicatorResultsPath
```
public abstract com.orchestranetworks.schema.Path getWatchdogIndicatorResultsPath()
```
    Returns the Path to the field of the watchdog indicator results.
  - getRemovedPath
```
public abstract com.orchestranetworks.schema.Path getRemovedPath()
```
    Returns the Path to the field indicating whether the current reporting record is considered removed.
  - getGroupingFieldPath
```
public abstract com.orchestranetworks.schema.Path getGroupingFieldPath()
```
    Returns the Path to the field of the target grouping field.
  - getGroupingValuePath
```
public abstract com.orchestranetworks.schema.Path getGroupingValuePath()
```
    Returns the Path to the field of the target grouping value.

EBX® Add-ons Version 5.3.0.

Copyright TIBCO Software Inc. 2001-2022. All rights reserved.
All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Class ReportingDefinition

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isFlatData

addPathAssociation

getParameterDefinitionNameForPath

getPathForParameterDefinition

hasPath

iterator

setDigitalChartViewSupported

setPieChartViewSupported

setBarChartViewSupported

isAnalyticViewSupported

isDigitalChartViewSupported

isPieChartViewSupported

isBarChartViewSupported

getReportingTablePathInSchema

getOidPath

getExecutionUUIDPath

getExecutionTimePath

getSequenceNumberPath

getWatchdogRaisedPath

getAutoEmailSentPath

getLanguagePath

getUserPath

getEmailOwnerPath

getOperationPath

getIndicatorCodePath

getIndicatorNamePath

getFkDECPath

getDECCodePath

getDataspacePath

getDatasetPath

getTablePath

getTableCodePath

getTableNamePath

getTableLinkPath

getTableFilterPredicatePath

getGroupPath

getGroupCodePath

getGroupNamePath

getFieldPath

getFieldCodePath

getFieldNamePath

getRecordPredicatePath

getRecordLinkPath

getWorkflowPublicationNamePath

getWorkflowPublicationKeyPath

getOperationKeyPath

getPeriodicityOfControlPath

getPeriodicityOfControlLabelPath

getPeriodStartDatePath

getPeriodEndDatePath

getMinThresholdPath

getMaxThresholdPath

getMinThresholdDecimalPath

getMaxThresholdDecimalPath

getToleranceNumberPath

getValidityStatusPath

getIntervalFormatPath

getLinkedRecordPath

getWatchdogIndicatorResultsPath

getRemovedPath

getGroupingFieldPath

getGroupingValuePath