Interface IndicatorDefinition

    • 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

        java.lang.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.
      • 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
      • getPossibleComputationFrequencies

        java.util.Set<FrequencyType> getPossibleComputationFrequencies()
        The types of the indicator's frequency.
        See Also:
        FrequencyType
      • getPossibleProbes

        java.util.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