oracle.epm.api.model

Enum AllocationParameters.AllocationMethod

java.lang.Object

java.lang.Enum<AllocationParameters.AllocationMethod>

oracle.epm.api.model.AllocationParameters.AllocationMethod

All Implemented Interfaces:

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

Enclosing class:

AllocationParameters

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

An enumeration containing a list of valid allocation methods to be used in Allocation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SHARE Allocate the amount(s) proportionately to the basis values.
SPREAD Allocate the amount(s) evenly.

Method Summary

Modifier and Type	Method and Description
static AllocationParameters.AllocationMethod	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AllocationParameters.AllocationMethod[]	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

SHARE

public static final AllocationParameters.AllocationMethod SHARE

Allocate the amount(s) proportionately to the basis values.

SPREAD

public static final AllocationParameters.AllocationMethod SPREAD

Allocate the amount(s) evenly. Do not set any basis when using this option.

Method Detail

valueOf

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

Returns:

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