Interface ICustomizationKPIType

  • All Superinterfaces:
    com4j.Com4jObject

    public interface ICustomizationKPIType
    extends com4j.Com4jObject
    For HP use. The QPM KPI Type.
    • Method Detail

      • name

        java.lang.String name()

        KPI Type name.

        Getter method for the COM property "Name"

        Returns:
        Returns a value of type java.lang.String
      • name

        void name​(java.lang.String pVal)

        KPI Type name.

        Setter method for the COM property "Name"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • description

        java.lang.String description()

        KPI Type description.

        Getter method for the COM property "Description"

        Returns:
        Returns a value of type java.lang.String
      • description

        void description​(java.lang.String pVal)

        KPI Type description.

        Setter method for the COM property "Description"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • entityType

        java.lang.String entityType()

        KPI Type entity type.

        Getter method for the COM property "EntityType"

        Returns:
        Returns a value of type java.lang.String
      • defaultTargetValue

        int defaultTargetValue()

        KPI Type default threshold target value.

        Getter method for the COM property "DefaultTargetValue"

        Returns:
        Returns a value of type int
      • defaultTargetValue

        void defaultTargetValue​(int pVal)

        KPI Type default threshold target value.

        Setter method for the COM property "DefaultTargetValue"

        Parameters:
        pVal - Mandatory int parameter.
      • measurementType

        java.lang.String measurementType()

        KPI Type measurement type.

        Getter method for the COM property "MeasurementType"

        Returns:
        Returns a value of type java.lang.String
      • numeratorFunctionName

        java.lang.String numeratorFunctionName()

        KPI Type numerator function name.

        Getter method for the COM property "NumeratorFunctionName"

        Returns:
        Returns a value of type java.lang.String
      • numeratorFunctionName

        void numeratorFunctionName​(java.lang.String pVal)

        KPI Type numerator function name.

        Setter method for the COM property "NumeratorFunctionName"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • numeratorFunctionSumField

        java.lang.String numeratorFunctionSumField()

        KPI Type numerator function summary field.

        Getter method for the COM property "NumeratorFunctionSumField"

        Returns:
        Returns a value of type java.lang.String
      • numeratorFunctionSumField

        void numeratorFunctionSumField​(java.lang.String pVal)

        KPI Type numerator function summary field.

        Setter method for the COM property "NumeratorFunctionSumField"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • numeratorFilter

        java.lang.String numeratorFilter()

        KPI Type numerator filter.

        Getter method for the COM property "NumeratorFilter"

        Returns:
        Returns a value of type java.lang.String
      • numeratorFilter

        void numeratorFilter​(java.lang.String pVal)

        KPI Type numerator filter.

        Setter method for the COM property "NumeratorFilter"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • numeratorTransitionField

        java.lang.String numeratorTransitionField()

        KPI Type numerator transition field.

        Getter method for the COM property "NumeratorTransitionField"

        Returns:
        Returns a value of type java.lang.String
      • numeratorTransitionField

        void numeratorTransitionField​(java.lang.String pVal)

        KPI Type numerator transition field.

        Setter method for the COM property "NumeratorTransitionField"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • numeratorTransitionFieldFromValues

        java.lang.String numeratorTransitionFieldFromValues()

        KPI Type numerator transition field from values.

        Getter method for the COM property "NumeratorTransitionFieldFromValues"

        Returns:
        Returns a value of type java.lang.String
      • numeratorTransitionFieldFromValues

        void numeratorTransitionFieldFromValues​(java.lang.String pVal)

        KPI Type numerator transition field from values.

        Setter method for the COM property "NumeratorTransitionFieldFromValues"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • numeratorTransitionFieldToValues

        java.lang.String numeratorTransitionFieldToValues()

        KPI Type numerator transition field to values.

        Getter method for the COM property "NumeratorTransitionFieldToValues"

        Returns:
        Returns a value of type java.lang.String
      • numeratorTransitionFieldToValues

        void numeratorTransitionFieldToValues​(java.lang.String pVal)

        KPI Type numerator transition field to values.

        Setter method for the COM property "NumeratorTransitionFieldToValues"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • numeratorTransitionPeriod

        java.lang.String numeratorTransitionPeriod()

        KPI Type numerator transition period.

        Getter method for the COM property "NumeratorTransitionPeriod"

        Returns:
        Returns a value of type java.lang.String
      • numeratorTransitionPeriod

        void numeratorTransitionPeriod​(java.lang.String pVal)

        KPI Type numerator transition period.

        Setter method for the COM property "NumeratorTransitionPeriod"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • denominatorFunctionName

        java.lang.String denominatorFunctionName()

        KPI Type denominator function name.

        Getter method for the COM property "DenominatorFunctionName"

        Returns:
        Returns a value of type java.lang.String
      • denominatorFunctionName

        void denominatorFunctionName​(java.lang.String pVal)

        KPI Type denominator function name.

        Setter method for the COM property "DenominatorFunctionName"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • denominatorFunctionSumField

        java.lang.String denominatorFunctionSumField()

        KPI Type denominator function summary field.

        Getter method for the COM property "DenominatorFunctionSumField"

        Returns:
        Returns a value of type java.lang.String
      • denominatorFunctionSumField

        void denominatorFunctionSumField​(java.lang.String pVal)

        KPI Type denominator function summary field.

        Setter method for the COM property "DenominatorFunctionSumField"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • denominatorFilter

        java.lang.String denominatorFilter()

        KPI Type denominator filter.

        Getter method for the COM property "DenominatorFilter"

        Returns:
        Returns a value of type java.lang.String
      • denominatorFilter

        void denominatorFilter​(java.lang.String pVal)

        KPI Type denominator filter.

        Setter method for the COM property "DenominatorFilter"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • denominatorTransitionField

        java.lang.String denominatorTransitionField()

        KPI Type denominator transition field.

        Getter method for the COM property "DenominatorTransitionField"

        Returns:
        Returns a value of type java.lang.String
      • denominatorTransitionField

        void denominatorTransitionField​(java.lang.String pVal)

        KPI Type denominator transition field.

        Setter method for the COM property "DenominatorTransitionField"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • denominatorTransitionFieldFromValues

        java.lang.String denominatorTransitionFieldFromValues()

        KPI Type denominator transition field from values.

        Getter method for the COM property "DenominatorTransitionFieldFromValues"

        Returns:
        Returns a value of type java.lang.String
      • denominatorTransitionFieldFromValues

        void denominatorTransitionFieldFromValues​(java.lang.String pVal)

        KPI Type denominator transition field from values.

        Setter method for the COM property "DenominatorTransitionFieldFromValues"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • denominatorTransitionFieldToValues

        java.lang.String denominatorTransitionFieldToValues()

        KPI Type denominator transition field to values.

        Getter method for the COM property "DenominatorTransitionFieldToValues"

        Returns:
        Returns a value of type java.lang.String
      • denominatorTransitionFieldToValues

        void denominatorTransitionFieldToValues​(java.lang.String pVal)

        KPI Type denominator transition field to values.

        Setter method for the COM property "DenominatorTransitionFieldToValues"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • kpiBetterWhenHigher

        boolean kpiBetterWhenHigher()

        KPI Type direction.

        Getter method for the COM property "KPIBetterWhenHigher"

        Returns:
        Returns a value of type boolean
      • kpiBetterWhenHigher

        void kpiBetterWhenHigher​(boolean pVal)

        KPI Type direction.

        Setter method for the COM property "KPIBetterWhenHigher"

        Parameters:
        pVal - Mandatory boolean parameter.
      • denominatorTransitionPeriod

        java.lang.String denominatorTransitionPeriod()

        KPI Type denominator transition period.

        Getter method for the COM property "DenominatorTransitionPeriod"

        Returns:
        Returns a value of type java.lang.String
      • denominatorTransitionPeriod

        void denominatorTransitionPeriod​(java.lang.String pVal)

        KPI Type denominator transition period.

        Setter method for the COM property "DenominatorTransitionPeriod"

        Parameters:
        pVal - Mandatory java.lang.String parameter.
      • updated

        boolean updated()

        Indicates if the kpi type object has changed locally since last synchronized with the server.

        Getter method for the COM property "Updated"

        Returns:
        Returns a value of type boolean
      • deleted

        boolean deleted()

        Indicates if the kpi type has been removed, but the deletion has not been posted to the server.

        Getter method for the COM property "Deleted"

        Returns:
        Returns a value of type boolean
      • deleted

        void deleted​(boolean pVal)

        Indicates if the kpi type has been removed, but the deletion has not been posted to the server.

        Setter method for the COM property "Deleted"

        Parameters:
        pVal - Mandatory boolean parameter.
      • _new

        boolean _new()

        Indicates if the KPI type has been created but not posted to the server.

        Getter method for the COM property "New"

        Returns:
        Returns a value of type boolean
      • id

        int id()

        The KPI Type ID.

        Getter method for the COM property "ID"

        Returns:
        Returns a value of type int
      • defaultTolerance

        double defaultTolerance()

        KPI Type default threshold value tolerance.

        Getter method for the COM property "DefaultTolerance"

        Returns:
        Returns a value of type double
      • defaultTolerance

        void defaultTolerance​(double pVal)

        KPI Type default threshold value tolerance.

        Setter method for the COM property "DefaultTolerance"

        Parameters:
        pVal - Mandatory double parameter.
      • breakdownTypes

        ICustomizationBreakdownTypes breakdownTypes()

        The list of BreakdownType objects for this KPI type.

        Getter method for the COM property "BreakdownTypes"

        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.ICustomizationBreakdownTypes
      • isReferenced

        boolean isReferenced()

        Checks if a KPI Type is used by a KPI.

        Getter method for the COM property "IsReferenced"

        Returns:
        Returns a value of type boolean
      • isTemplate

        boolean isTemplate()

        Checks if a KPI Type is linked to template.

        Getter method for the COM property "IsTemplate"

        Returns:
        Returns a value of type boolean