oracle.epm.api.model

Enum AllocationParameters.NegativeBasisOption

java.lang.Object

java.lang.Enum<AllocationParameters.NegativeBasisOption>

oracle.epm.api.model.AllocationParameters.NegativeBasisOption

All Implemented Interfaces:

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

Enclosing class:

AllocationParameters

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT Cancel the allocation.
ABS Use absolute value.
DEFAULT Default behavior.
MISSING Treat it as #missing.
NEXT_AMOUNT Skip to next amount value.
ZERO Treat it as a zero when allocation method is SPREAD.

Method Summary

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

ABORT

public static final AllocationParameters.NegativeBasisOption ABORT

Cancel the allocation.

ABS

public static final AllocationParameters.NegativeBasisOption ABS

Use absolute value.

DEFAULT

public static final AllocationParameters.NegativeBasisOption DEFAULT

Default behavior.

MISSING

public static final AllocationParameters.NegativeBasisOption MISSING

Treat it as #missing.

NEXT_AMOUNT

public static final AllocationParameters.NegativeBasisOption NEXT_AMOUNT

Skip to next amount value.

ZERO

public static final AllocationParameters.NegativeBasisOption ZERO

Treat it as a zero when allocation method is SPREAD.

Method Detail

getValue

public long getValue()

value of the object.

Returns:

value

valueOf

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

Returns:

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