com.essbase.api.datasource

Enum IEssCustomObject.CustomObjectCopyOption

java.lang.Object

java.lang.Enum<IEssCustomObject.CustomObjectCopyOption>

com.essbase.api.datasource.IEssCustomObject.CustomObjectCopyOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IEssCustomObject.CustomObjectCopyOption>

Enclosing interface:

IEssCustomObject

public static enum IEssCustomObject.CustomObjectCopyOption
extends java.lang.Enum<IEssCustomObject.CustomObjectCopyOption>

Options available for copying Custom Objects.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPTEXISTING_CONFLICT Accept the existing object (i.e., object not overwritten) on a conflict, while deep copying the object.
COPYNEWER_CONFLICT Overwrite custom object with newer version on a conflict while deep copying the object.
ERROROUT_CONFLICT Error out on a conflict while trying to perform a deep copy of the object.

Method Summary

Modifier and Type	Method and Description
static IEssCustomObject.CustomObjectCopyOption	getCustomObjectCopyOption(int ordinal)
static IEssCustomObject.CustomObjectCopyOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IEssCustomObject.CustomObjectCopyOption[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COPYNEWER_CONFLICT

public static final IEssCustomObject.CustomObjectCopyOption COPYNEWER_CONFLICT

Overwrite custom object with newer version on a conflict while deep copying the object.

ACCEPTEXISTING_CONFLICT

public static final IEssCustomObject.CustomObjectCopyOption ACCEPTEXISTING_CONFLICT

Accept the existing object (i.e., object not overwritten) on a conflict, while deep copying the object.

ERROROUT_CONFLICT

public static final IEssCustomObject.CustomObjectCopyOption ERROROUT_CONFLICT

Error out on a conflict while trying to perform a deep copy of the object.

Method Detail

values

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

Returns:

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

valueOf

public static IEssCustomObject.CustomObjectCopyOption 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

getCustomObjectCopyOption

public static final IEssCustomObject.CustomObjectCopyOption getCustomObjectCopyOption(int ordinal)