Package com.appliedolap.essbase

Enum Class EssScript.ScriptType

java.lang.Object

java.lang.Enum<EssScript.ScriptType>

com.appliedolap.essbase.EssScript.ScriptType

All Implemented Interfaces:

Serializable, Comparable<EssScript.ScriptType>, Constable

Enclosing interface:

EssScript

public static enum EssScript.ScriptType
extends Enum<EssScript.ScriptType>

Which kind of script this is, which decides both the endpoint's file parameter and how the script is run.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CALC	A calculation script.
MDX	An MDX script.

Method Summary

Modifier and Type	Method	Description
String	getExtension()	The file extension Essbase stores the script under.
String	getLabel()	The kind as a person would write it.
String	getParameter()	The value the scripts endpoints want in file.
static EssScript.ScriptType	parse(String text)
static EssScript.ScriptType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EssScript.ScriptType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CALC

public static final EssScript.ScriptType CALC

A calculation script.

MDX

public static final EssScript.ScriptType MDX

An MDX script.

Method Details

values

public static EssScript.ScriptType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EssScript.ScriptType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getParameter

public String getParameter()

The value the scripts endpoints want in file. Sending anything else - including an empty string, which is what a Swagger UI form does with a blank field - is rejected with "Invalid file type. Supported files are Calculation and MDX scripts".

Returns:

the parameter value

getExtension

public String getExtension()

The file extension Essbase stores the script under. Needed because running an MDX script identifies it by file name rather than by script name - see EssScript.execute().

Returns:

the extension, dot included

getLabel

public String getLabel()

The kind as a person would write it.

parse

public static EssScript.ScriptType parse(String text)