com.genesyslab.wfm7.API.service.forecast750

## Class FrcData

- java.lang.Object
- - com.genesyslab.wfm7.API.service.forecast750.FrcData

- All Implemented Interfaces:
    java.io.Serializable

      public class FrcData
      extends java.lang.Object
      implements java.io.Serializable

  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `private java.lang.Object` | `__equalsCalc`
    `private boolean` | `__hashCodeCalc`
    `private int` | `granularity` Data granularity
    `private int` | `item` Forecast data item
    `private double` | `start` Forecast data start date
    `private double` | `totalValue` Total Forecast data value
    `private double[]` | `values` Forecast data values
    `private int` | `valuesArraySize` Value array size

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `FrcData()`
    `FrcData(int item, double start, int granularity, int valuesArraySize, double[] values, double totalValue)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `int` | `getGranularity()` Gets the granularity value for this FrcData.
    `int` | `getItem()` Gets the item value for this FrcData.
    `double` | `getStart()` Gets the start value for this FrcData.
    `double` | `getTotalValue()` Gets the totalValue value for this FrcData.
    `double[]` | `getValues()` Gets the values value for this FrcData.
    `int` | `getValuesArraySize()` Gets the valuesArraySize value for this FrcData.
    `int` | `hashCode()`
    `void` | `setGranularity(int granularity)` Sets the granularity value for this FrcData.
    `void` | `setItem(int item)` Sets the item value for this FrcData.
    `void` | `setStart(double start)` Sets the start value for this FrcData.
    `void` | `setTotalValue(double totalValue)` Sets the totalValue value for this FrcData.
    `void` | `setValues(double[] values)` Sets the values value for this FrcData.
    `void` | `setValuesArraySize(int valuesArraySize)` Sets the valuesArraySize value for this FrcData.

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### item

          private int item

      Forecast data item
      See Also:
        `EFrcDataTypes`

    - #### start

          private double start

      Forecast data start date

    - #### granularity

          private int granularity

      Data granularity

    - #### valuesArraySize

          private int valuesArraySize

      Value array size

    - #### values

          private double[] values

      Forecast data values

    - #### totalValue

          private double totalValue

      Total Forecast data value

    - #### __equalsCalc

          private java.lang.Object __equalsCalc

    - #### __hashCodeCalc

          private boolean __hashCodeCalc

  - ### Constructor Detail

    - #### FrcData

          public FrcData()

    - #### FrcData

          public FrcData(int item,
                 double start,
                 int granularity,
                 int valuesArraySize,
                 double[] values,
                 double totalValue)

  - ### Method Detail

    - #### getItem

          public int getItem()

      Gets the item value for this FrcData.
      Returns:
        item Forecast data type
      See Also:
        `EFrcDataTypes`

    - #### setItem

          public void setItem(int item)

      Sets the item value for this FrcData.
      Parameters:
        `item` - Forecast data type
      See Also:
        `EFrcDataTypes`

    - #### getStart

          public double getStart()

      Gets the start value for this FrcData.
      Returns:
        start Data period start date and time

    - #### setStart

          public void setStart(double start)

      Sets the start value for this FrcData.
      Parameters:
        `start` - Data period start date and time

    - #### getGranularity

          public int getGranularity()

      Gets the granularity value for this FrcData.
      Returns:
        granularity Interval between data value periods, e.g. 15 for time step. Special values: 0 - for total period value; -1 - calendar month; -10 - calendar week starts Sunday; -11 - calendar week starts Mon.; -12 - calendar week starts Tue.; -13 - calendar week starts Wed.; -14 - calendar week starts Thu.; -15 - calendar week starts Fri.; -16 - calendar week starts Sat.

    - #### setGranularity

          public void setGranularity(int granularity)

      Sets the granularity value for this FrcData.
      Parameters:
        `granularity` - Interval between data value periods, e.g. 15 for time step. Special values: 0 - for total period value; -1 - calendar month; -10 - calendar week starts Sunday; -11 - calendar week starts Mon.; -12 - calendar week starts Tue.; -13 - calendar week starts Wed.; -14 - calendar week starts Thu.; -15 - calendar week starts Fri.; -16 - calendar week starts Sat.

    - #### getValuesArraySize

          public int getValuesArraySize()

      Gets the valuesArraySize value for this FrcData.
      Returns:
        valuesArraySize Forecast data values array size

    - #### setValuesArraySize

          public void setValuesArraySize(int valuesArraySize)

      Sets the valuesArraySize value for this FrcData.
      Parameters:
        `valuesArraySize` - Forecast data values array size

    - #### getValues

          public double[] getValues()

      Gets the values value for this FrcData.
      Returns:
        values Array of forecast data values in requested date range

    - #### setValues

          public void setValues(double[] values)

      Sets the values value for this FrcData.
      Parameters:
        `values` - Array of forecast data values in requested date range

    - #### getTotalValue

          public double getTotalValue()

      Gets the totalValue value for this FrcData.
      Returns:
        totalValue Total value for the requested date range

    - #### setTotalValue

          public void setTotalValue(double totalValue)

      Sets the totalValue value for this FrcData.
      Parameters:
        `totalValue` - Total value for the requested date range

    - #### equals

          public boolean equals(java.lang.Object obj)

      Overrides:
        `equals` in class `java.lang.Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `java.lang.Object`

Copyright © 2005-2016 Genesys Telecommunications Labs, Inc. All Rights Reserved.