oracle.epm.api.model

Enum FiscalYearStart

java.lang.Object

java.lang.Enum<FiscalYearStart>

oracle.epm.api.model.FiscalYearStart

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FiscalYearStart>

public enum FiscalYearStart
extends java.lang.Enum<FiscalYearStart>

An enumeration containing a list of valid fiscal year start types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PREVIOUS_CALENDAR_YEAR
SAME_CALENDAR_YEAR

Method Summary

Modifier and Type	Method and Description
static FiscalYearStart	fromString(java.lang.String displayName) Returns an instance of the enum with the specified display name.
java.lang.String	getDisplayName() Returns the name of this enum constant, as contained in the declaration.
static FiscalYearStart	getFiscalYearStart(int fiscalYearType) Returns an instance of the enum with the specified type.
int	getType() Returns the integer type of this enum constant, as contained in the declaration.
java.lang.String	toString() Returns the display name of this enum constant, as contained in the declaration.
static FiscalYearStart	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FiscalYearStart[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PREVIOUS_CALENDAR_YEAR

public static final FiscalYearStart PREVIOUS_CALENDAR_YEAR

SAME_CALENDAR_YEAR

public static final FiscalYearStart SAME_CALENDAR_YEAR

Method Detail

fromString

public static FiscalYearStart fromString(java.lang.String displayName)

Returns an instance of the enum with the specified display name.

Parameters:

displayName - user friendly name

Returns:

an instance of the enum with the specified display name

getDisplayName

public java.lang.String getDisplayName()

Returns the name of this enum constant, as contained in the declaration.

Returns:

the name of this enum constant, as contained in the declaration

getFiscalYearStart

public static FiscalYearStart getFiscalYearStart(int fiscalYearType)

Returns an instance of the enum with the specified type.

Parameters:

fiscalYearType - fiscal year start type

Returns:

an instance of the enum with the specified type

getType

public int getType()

Returns the integer type of this enum constant, as contained in the declaration.

Returns:

the integer type of this enum constant, as contained in the declaration

toString

public java.lang.String toString()

Returns the display name of this enum constant, as contained in the declaration.

Overrides:

toString in class java.lang.Enum<FiscalYearStart>

Returns:

the display name of this enum constant, as contained in the declaration

valueOf

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

Returns:

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