oracle.epm.api.model

Enum AllocationParameters.BasisTimeSpanOption

java.lang.Object

java.lang.Enum<AllocationParameters.BasisTimeSpanOption>

oracle.epm.api.model.AllocationParameters.BasisTimeSpanOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AllocationParameters.BasisTimeSpanOption>

Enclosing class:

AllocationParameters

public static enum AllocationParameters.BasisTimeSpanOption
extends java.lang.Enum<AllocationParameters.BasisTimeSpanOption>

An enumeration containing a list of valid basis timespan options to be used in Allocation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMBINE_BASIS Use the sum of the basis values across the time periods specified by basis timespan.
SPLIT_BASIS Use the basis value for each time period individually.

Method Summary

Modifier and Type	Method and Description
static AllocationParameters.BasisTimeSpanOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AllocationParameters.BasisTimeSpanOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COMBINE_BASIS

public static final AllocationParameters.BasisTimeSpanOption COMBINE_BASIS

Use the sum of the basis values across the time periods specified by basis timespan.

See Also:

AllocationParameters.setBasisTimeSpan(java.lang.String)

SPLIT_BASIS

public static final AllocationParameters.BasisTimeSpanOption SPLIT_BASIS

Use the basis value for each time period individually.

Method Detail

valueOf

public static AllocationParameters.BasisTimeSpanOption valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

values

public static AllocationParameters.BasisTimeSpanOption[] 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 (AllocationParameters.BasisTimeSpanOption c : AllocationParameters.BasisTimeSpanOption.values())
    System.out.println(c);

Returns:

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