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

All Known Implementing Classes:

DefaultDECIndicator, DefaultWorkflowIndicator
```
public interface IndicatorDefinition
```
Defines an indicator.
Guides and inputs the indicator declaration in the user interface.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`BigDataDefinition`	`getBigDataDefinition()` Returns the definition of the fields in the `Big data report` table which the indicator can update.
`String`	`getCode()` Returns the business code of the indicator.
`com.onwbp.base.text.UserMessage`	`getDashboardLabel()` Returns the label to be displayed in a dashboard tile.
`DECSubType`	`getDECSubType()` Returns the optional sub-type of the Data Element Concept on which the indicator can be executed.
`DECType`	`getDECType()` Returns the type of the Data Element Concept on which the indicator can be executed.
`com.onwbp.base.text.UserMessage`	`getDescription()` Returns the business description of the indicator.
`FlatDataDefinition`	`getFlatDataDefinition()` Returns the definition of the fields in the `Flat data report` table which the indicator can update.
`Indicator`	`getImplementation()` Returns the instance for business implementation of the indicator.
`List<ParameterDefinition>`	`getInputParametersDefinition()` Returns the input parameters of the indicator.
`com.onwbp.base.text.UserMessage`	`getLabel()` Returns the label of the indicator.
`LinkedRecordDefinition`	`getLinkedRecordDefinition()` Returns the definition of the linked records.
`List<ParameterDefinition>`	`getOutputParametersDefinition()` Returns the output parameters of the indicator.
`Set<FrequencyType>`	`getPossibleComputationFrequencies()` The types of the indicator's frequency.
`Set<ProbeType>`	`getPossibleProbes()` Returns the types of the indicator's probe.
`com.onwbp.base.text.UserMessage`	`getStorageProcedureInformation()` Returns the information regarding the storage procedure.
`WatchdogInformation`	`getWatchdogInformation()` Returns the definition of the watchdog.
`boolean`	`hasManyOutcomesStoredInBigDataTable()` Deprecated. Since 2.0.0, use `hasManyOutcomesStoredInReportingTable()` instead.
`boolean`	`hasManyOutcomesStoredInReportingTable()` Returns `true` if this indicator can have many outcomes with different sequences in the reporting tables.
`boolean`	`isLinkedRecordVisibleOnIndicatorOnDECTable(com.onwbp.adaptation.Adaptation record)` Returns `true` if the Linked record field is visible on the Indicator on DEC table.
`boolean`	`isLinkedRecordVisibleOnIndicatorTable()` Returns `true` if the Linked record field is visible on the Indicator table.
`boolean`	`isTableFilterPredicateSupported()` Returns `true` if this indicator supports table filter predicates.

- Method Detail
  - getLabel
```
com.onwbp.base.text.UserMessage getLabel()
```
    Returns the label of the indicator.
  - getDashboardLabel
```
com.onwbp.base.text.UserMessage getDashboardLabel()
```
    Returns the label to be displayed in a dashboard tile.
    
    Since v1.5.2, this label is no longer limited to 35 characters to be properly displayed.
    
    Since:
    
    1.2.0
  - getDescription
```
com.onwbp.base.text.UserMessage getDescription()
```
    Returns the business description of the indicator.
    
    Since:
    
    1.4.0
  - getCode
```
String getCode()
```
    Returns the business code of the indicator.
    
    Since v1.5.2, this unique code is used to identify an indicator definition.
    
    Since:
    
    1.2.0
  - getImplementation
```
Indicator getImplementation()
```
    Returns the instance for business implementation of the indicator.
    
    See Also:
    
    Indicator
  - getDECType
```
DECType getDECType()
```
    Returns the type of the Data Element Concept on which the indicator can be executed.
    
    See Also:
    
    DECType
  - getDECSubType
```
DECSubType getDECSubType()
```
    Returns the optional sub-type of the Data Element Concept on which the indicator can be executed.
    
    Returns null if no sub-type.
    
    Since:
    
    1.2.0
    
    See Also:
    
    DECSubType
  - getStorageProcedureInformation
```
com.onwbp.base.text.UserMessage getStorageProcedureInformation()
```
    Returns the information regarding the storage procedure.
  - getWatchdogInformation
```
WatchdogInformation getWatchdogInformation()
```
    Returns the definition of the watchdog.
    
    See Also:
    
    WatchdogInformation
  - getOutputParametersDefinition
```
List<ParameterDefinition> getOutputParametersDefinition()
```
    Returns the output parameters of the indicator.
    
    See Also:
    
    ParameterDefinition
  - hasManyOutcomesStoredInBigDataTable
```
@Deprecated
boolean hasManyOutcomesStoredInBigDataTable()
```
    Deprecated. Since 2.0.0, use hasManyOutcomesStoredInReportingTable() instead.
    
    Returns true if this indicator can have many outcomes with different sequences in the Big data table.
    
    Since:
    
    1.4.0
  - hasManyOutcomesStoredInReportingTable
```
boolean hasManyOutcomesStoredInReportingTable()
```
    Returns true if this indicator can have many outcomes with different sequences in the reporting tables.
    
    Since:
    
    2.0.0
  - getInputParametersDefinition
```
List<ParameterDefinition> getInputParametersDefinition()
```
    Returns the input parameters of the indicator.
    
    See Also:
    
    ParameterDefinition
  - getPossibleComputationFrequencies
```
Set<FrequencyType> getPossibleComputationFrequencies()
```
    The types of the indicator's frequency.
    
    See Also:
    
    FrequencyType
  - getPossibleProbes
```
Set<ProbeType> getPossibleProbes()
```
    Returns the types of the indicator's probe.
    
    See Also:
    
    ProbeType
  - getBigDataDefinition
```
BigDataDefinition getBigDataDefinition()
```
    Returns the definition of the fields in the Big data report table which the indicator can update.
    Since 2.0.0, it's recommended to return null and define FlatDataDefinition instead.
    
    In order to migrate data of an indicator defined in a version prior to 2.0.0 from the Big data report table to the Flat data report table, BigDataDefinition must be kept.
    
    See Also:
    
    BigDataDefinition, getFlatDataDefinition()
  - getFlatDataDefinition
```
FlatDataDefinition getFlatDataDefinition()
```
    Returns the definition of the fields in the Flat data report table which the indicator can update.
    
    Since:
    
    2.0.0
    
    See Also:
    
    FlatDataDefinition
  - getLinkedRecordDefinition
```
LinkedRecordDefinition getLinkedRecordDefinition()
```
    Returns the definition of the linked records.
    
    Returns:
    
    Returns null if this indicator doesn't need to store the relevant records.
    
    Since:
    
    1.4.0
    
    See Also:
    
    LinkedRecordDefinition
  - isLinkedRecordVisibleOnIndicatorTable
```
boolean isLinkedRecordVisibleOnIndicatorTable()
```
    Returns true if the Linked record field is visible on the Indicator table.
    
    Since:
    
    2.5.0
    
    See Also:
    
    LinkedRecordDefinition
  - isLinkedRecordVisibleOnIndicatorOnDECTable
```
boolean isLinkedRecordVisibleOnIndicatorOnDECTable(com.onwbp.adaptation.Adaptation record)
```
    Returns true if the Linked record field is visible on the Indicator on DEC table.
    
    Since:
    
    2.5.0
    
    See Also:
    
    LinkedRecordDefinition
  - isTableFilterPredicateSupported
```
boolean isTableFilterPredicateSupported()
```
    Returns true if this indicator supports table filter predicates.
    
    Since:
    
    2.1.0

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.

Interface IndicatorDefinition

Method Summary

Method Detail

getLabel

getDashboardLabel

getDescription

getCode

getImplementation

getDECType

getDECSubType

getStorageProcedureInformation

getWatchdogInformation

getOutputParametersDefinition

hasManyOutcomesStoredInBigDataTable

hasManyOutcomesStoredInReportingTable

getInputParametersDefinition

getPossibleComputationFrequencies

getPossibleProbes

getBigDataDefinition

getFlatDataDefinition

getLinkedRecordDefinition

isLinkedRecordVisibleOnIndicatorTable

isLinkedRecordVisibleOnIndicatorOnDECTable

isTableFilterPredicateSupported