Primavera Integration API Release 8

com.primavera.common.value
Enum SpreadBucketType

java.lang.Object
  extended by java.lang.Enum<SpreadBucketType>
      extended by com.primavera.common.value.SpreadBucketType
All Implemented Interfaces:
Serializable, Comparable<SpreadBucketType>

public enum SpreadBucketType
extends Enum<SpreadBucketType>

SpreadBucketType defines the bucket types for which spreads are calculated and stored.


Enum Constant Summary
SBT_DAY
           
SBT_FINANCIAL_PERIOD
           
SBT_HOUR
           
SBT_MONTH
           
SBT_NONE
           
SBT_QUARTER
           
SBT_WEEK
           
SBT_YEAR
           
 
Method Summary
static SpreadBucketType fromInt(int oldConstantVal)
          Gets a SpreadBucketType instance based on the internal constant passed as an argument.
 int getMode()
          Gets an internal mode value.
 String toString()
          Returns a string representation of the object.
static SpreadBucketType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static SpreadBucketType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

SBT_NONE

public static final SpreadBucketType SBT_NONE

SBT_HOUR

public static final SpreadBucketType SBT_HOUR

SBT_DAY

public static final SpreadBucketType SBT_DAY

SBT_WEEK

public static final SpreadBucketType SBT_WEEK

SBT_MONTH

public static final SpreadBucketType SBT_MONTH

SBT_QUARTER

public static final SpreadBucketType SBT_QUARTER

SBT_YEAR

public static final SpreadBucketType SBT_YEAR

SBT_FINANCIAL_PERIOD

public static final SpreadBucketType SBT_FINANCIAL_PERIOD
Method Detail

values

public static SpreadBucketType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (SpreadBucketType c : SpreadBucketType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SpreadBucketType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getMode

public int getMode()
Gets an internal mode value. This method should not be called from client code.

Returns:
an internal mode value

toString

public String toString()
Returns a string representation of the object.

Overrides:
toString in class Enum<SpreadBucketType>
Returns:
a string representation of the object

fromInt

public static SpreadBucketType fromInt(int oldConstantVal)
Gets a SpreadBucketType instance based on the internal constant passed as an argument.

Parameters:
oldConstantVal - the internal constant value
Returns:
SpreadBucketType the unique SpreadBucketType instance

Primavera Integration API Release 8

Copyright © 2003, 2010, Oracle and/or its affiliates. All rights reserved.