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

```
public interface IndicatorDefinitionContext
```
Represents the configuration of an IndicatorDefinition.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getBespokeParameterValue(String key)` Returns the value of the input parameter when `ParameterDefinition.isList()` returns `false`.
`List<String>`	`getBespokeParameterValues(String key)` Returns the values of the input parameter when `ParameterDefinition.isList()` returns `true`.
`com.onwbp.adaptation.Adaptation`	`getContextDataset()` Returns the data set configured for `Indicator` execution.
`String`	`getDECBusinessCode()` Returns the business code of the data element concept to execute.
`com.onwbp.adaptation.PrimaryKey`	`getDECCode()` Returns the primary key of the data element concept to execute.
`com.onwbp.base.text.UserMessage`	`getDECName()` Returns the name of the data element concept to execute.
`com.orchestranetworks.schema.Path`	`getDECTablePath()` Returns the configured table path.
`DECType`	`getDECType()` Returns the current `DECType`.
`com.orchestranetworks.schema.Path`	`getField()` Returns the configured field path.
`String`	`getGroupingDisplayOptions()` Returns grouping display options.
`com.orchestranetworks.schema.Path`	`getGroupingField()` Returns the configured field group by path.
`com.orchestranetworks.schema.Path`	`getGroupPath()` Returns the configured group path.
`String`	`getGroupPriority()` Returns group priority.
`com.onwbp.adaptation.PrimaryKey`	`getIndicatorCode()` Returns the primary key of the Indicator to execute.
`com.onwbp.base.text.UserMessage`	`getIndicatorDescription()` Returns the business description of the Indicator to execute.
`com.onwbp.base.text.UserMessage`	`getIndicatorName()` Returns the name of the Indicator to execute.
`LinkedRecordInformation`	`getLinkedRecordInformation()` Returns the linked record information.
`Integer`	`getMaximumNumberOfGroups()` Returns maximum number of groups.
`String`	`getOperationIdentifier()` Returns the operation identifier.
`String`	`getOtherGroupName()` Returns other group name.
`List<String>`	`getOwnersEmails()` Returns e-mails for the configured owner.
`String`	`getPublicationView()` Returns the publication name of the Indicator view.
`IndicatorStorage`	`getStorage()` Returns the configured storage.
`String`	`getValidityStatus()` Returns the validity status.
`Watchdog`	`getWatchdog()` Returns the `Watchdog`.
`com.orchestranetworks.workflow.PublishedProcessKey`	`getWorkflowKey()` Returns the configured workflow key.
`String`	`getXPathPredicate()` Returns the XPath predicate configured for `Indicator` execution.
`Boolean`	`isGroupBy()` Returns is group by.
`boolean`	`saveLastValueOnlyInFlatDataTable()` Returns the configured boolean value.
`boolean`	`saveLastValueOnlyInIndicatorReportTable()` Returns the configured boolean value.
`boolean`	`saveLastValueOnlyOnBigDataTable()` Deprecated. Since 2.0.0 use `saveLastValueOnlyInFlatDataTable()` instead.
`boolean`	`saveLastValueOnlyOnReportingTable()` Deprecated. Since 2.0.0 use `saveLastValueOnlyInIndicatorReportTable()` instead.

- Method Detail
  - getStorage
```
IndicatorStorage getStorage()
```
    Returns the configured storage.
  - getDECTablePath
```
com.orchestranetworks.schema.Path getDECTablePath()
```
    Returns the configured table path.
  - getField
```
com.orchestranetworks.schema.Path getField()
```
    Returns the configured field path.
  - getGroupPath
```
com.orchestranetworks.schema.Path getGroupPath()
```
    Returns the configured group path.
    
    Since:
    
    1.2.0
  - getWorkflowKey
```
com.orchestranetworks.workflow.PublishedProcessKey getWorkflowKey()
```
    Returns the configured workflow key.
  - getDECCode
```
com.onwbp.adaptation.PrimaryKey getDECCode()
```
    Returns the primary key of the data element concept to execute.
  - getDECName
```
com.onwbp.base.text.UserMessage getDECName()
```
    Returns the name of the data element concept to execute.
  - getDECBusinessCode
```
String getDECBusinessCode()
```
    Returns the business code of the data element concept to execute.
    
    Since:
    
    1.3.0
  - getDECType
```
DECType getDECType()
```
    Returns the current DECType.
    
    Since:
    
    1.3.0
  - getIndicatorCode
```
com.onwbp.adaptation.PrimaryKey getIndicatorCode()
```
    Returns the primary key of the Indicator to execute.
  - getIndicatorName
```
com.onwbp.base.text.UserMessage getIndicatorName()
```
    Returns the name of the Indicator to execute.
  - getIndicatorDescription
```
com.onwbp.base.text.UserMessage getIndicatorDescription()
```
    Returns the business description of the Indicator to execute.
    
    Since:
    
    1.5.2
  - getPublicationView
```
String getPublicationView()
```
    Returns the publication name of the Indicator view.
  - saveLastValueOnlyOnReportingTable
```
@Deprecated
boolean saveLastValueOnlyOnReportingTable()
```
    Deprecated. Since 2.0.0 use saveLastValueOnlyInIndicatorReportTable() instead.
    
    Returns the configured boolean value.
    If true, the Indicator report and the Indicator value table does not keep the history of indicator results.
  - saveLastValueOnlyInIndicatorReportTable
```
boolean saveLastValueOnlyInIndicatorReportTable()
```
    Returns the configured boolean value.
    If true, the Indicator report and the Indicator value table does not keep the history of indicator results.
    
    Since:
    
    2.0.0
  - saveLastValueOnlyOnBigDataTable
```
@Deprecated
boolean saveLastValueOnlyOnBigDataTable()
```
    Deprecated. Since 2.0.0 use saveLastValueOnlyInFlatDataTable() instead.
    
    Returns the configured boolean value.
    If true, the Big data table does not keep the history of indicator results.
  - saveLastValueOnlyInFlatDataTable
```
boolean saveLastValueOnlyInFlatDataTable()
```
    Returns the configured boolean value.
    If true, the Flat data table or the Big data table does not keep the history of indicator results.
    
    Since:
    
    2.0.0
  - getWatchdog
```
Watchdog getWatchdog()
```
    Returns the Watchdog.
  - getBespokeParameterValue
```
String getBespokeParameterValue(String key)
```
    Returns the value of the input parameter when ParameterDefinition.isList() returns false.
    
    Parameters:
    
    key - the input parameter key.
    
    See Also:
    
    ParameterDefinition
  - getBespokeParameterValues
```
List<String> getBespokeParameterValues(String key)
```
    Returns the values of the input parameter when ParameterDefinition.isList() returns true.
    
    Parameters:
    
    key - the input parameter key.
    
    Since:
    
    1.3.0
    
    See Also:
    
    ParameterDefinition
  - getOwnersEmails
```
List<String> getOwnersEmails()
```
    Returns e-mails for the configured owner.
  - getValidityStatus
```
String getValidityStatus()
```
    Returns the validity status.
  - getOperationIdentifier
```
String getOperationIdentifier()
```
    Returns the operation identifier.
    
    Since:
    
    1.4.0
  - getLinkedRecordInformation
```
LinkedRecordInformation getLinkedRecordInformation()
```
    Returns the linked record information.
    Returns null if IndicatorDefinition.getLinkedRecordDefinition() is not defined.
    
    Since:
    
    1.4.0
  - getContextDataset
```
com.onwbp.adaptation.Adaptation getContextDataset()
```
    Returns the data set configured for Indicator execution.
    Returns null if the execution environment is not a data set, table, group, or field.
    
    Since:
    
    1.5.2
  - getXPathPredicate
```
String getXPathPredicate()
```
    Returns the XPath predicate configured for Indicator execution.
    Returns an empty string if this is not an indicator at the table level.
    
    Since:
    
    2.0.0
  - isGroupBy
```
Boolean isGroupBy()
```
    Returns is group by.
    
    Since:
    
    2.3.0
  - getMaximumNumberOfGroups
```
Integer getMaximumNumberOfGroups()
```
    Returns maximum number of groups.
    
    Since:
    
    2.3.0
  - getGroupPriority
```
String getGroupPriority()
```
    Returns group priority.
    
    Since:
    
    2.3.0
  - getOtherGroupName
```
String getOtherGroupName()
```
    Returns other group name.
    
    Since:
    
    2.3.0
  - getGroupingDisplayOptions
```
String getGroupingDisplayOptions()
```
    Returns grouping display options.
    
    Since:
    
    2.3.0
  - getGroupingField
```
com.orchestranetworks.schema.Path getGroupingField()
```
    Returns the configured field group by path.
    
    Since:
    
    2.3.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 IndicatorDefinitionContext

Method Summary

Method Detail

getStorage

getDECTablePath

getField

getGroupPath

getWorkflowKey

getDECCode

getDECName

getDECBusinessCode

getDECType

getIndicatorCode

getIndicatorName

getIndicatorDescription

getPublicationView

saveLastValueOnlyOnReportingTable

saveLastValueOnlyInIndicatorReportTable

saveLastValueOnlyOnBigDataTable

saveLastValueOnlyInFlatDataTable

getWatchdog

getBespokeParameterValue

getBespokeParameterValues

getOwnersEmails

getValidityStatus

getOperationIdentifier

getLinkedRecordInformation

getContextDataset

getXPathPredicate

isGroupBy

getMaximumNumberOfGroups

getGroupPriority

getOtherGroupName

getGroupingDisplayOptions

getGroupingField