Package com.primavera.integration.client.bo.enm

Class SpreadPeriodType

java.lang.Object
com.primavera.integration.client.bo.enm.EnumType
com.primavera.integration.client.bo.enm.SpreadPeriodType
public class SpreadPeriodType extends EnumType
Spread period type enumerations are used to specify the spread interval for EPS, project, WBS, Activity, and resource assignment spreads. Valid values are 'Hour', 'Day', 'Week', 'Month', 'Quarter', 'Year' and 'FinancialPeriod'.

To use an enumeration in a where clause, make sure you use the internal database value. This can be retrieved from a particular enum instance by calling getValue().

  • Field Details

  • Method Details

    • toString

      public String toString()
      Returns a string representation of the object, which is the same as the description returned by the getDescription() method
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object

    • getValue

      public String getValue()
      Gets the internal value of this SpreadPeriodType instance
      Specified by:
      getValue in class EnumType
      Returns:
      String the internal value

    • getDescription

      public String getDescription()
      Gets the description of this SpreadPeriodType instance
      Specified by:
      getDescription in class EnumType
      Returns:
      String the description

    • getSpreadPeriodType

      public static SpreadPeriodType getSpreadPeriodType(String sSpreadPeriodType)
      Gets an instance of SpreadPeriodType based on the String value specified.
      Parameters:
      sSpreadPeriodType - the internal value or description
      Returns:
      SpreadPeriodType the unique SpreadPeriodType instance

    • getSpreadPeriodType

      public static SpreadPeriodType getSpreadPeriodType(int iSpreadPeriodType)
      Gets an instance of SpreadPeriodType based on the integer value specified.
      Parameters:
      iSpreadPeriodType - an integer representing a particular value of this class. This value is also used when exporting to XML.
      Returns:
      SpreadPeriodType the unique SpreadPeriodType instance

    • getEnumValues

      public static String[] getEnumValues()
      Gets an array of all internal values for this enumeration
      Returns:
      String[] an array of all internal values

    • getEnumDescriptions

      public static String[] getEnumDescriptions()
      Gets an array of all descriptions for this enumeration
      Returns:
      String[] an array of all descriptions