Package com.appliedolap.essbase

Enum Class EssJob.JobType

java.lang.Object
java.lang.Enum<EssJob.JobType>
com.appliedolap.essbase.EssJob.JobType
All Implemented Interfaces:
Serializable, Comparable<EssJob.JobType>, Constable
Enclosing interface:
EssJob
public static enum EssJob.JobType extends Enum<EssJob.JobType>
Known job types.

  • Enum Constant Details

    • LOAD_DATA

      public static final EssJob.JobType LOAD_DATA

    • BUILD_DIMENSIONS

      public static final EssJob.JobType BUILD_DIMENSIONS

    • RUN_CALCULATION

      public static final EssJob.JobType RUN_CALCULATION

    • CLEAR_DATA

      public static final EssJob.JobType CLEAR_DATA

    • IMPORT_EXCEL

      public static final EssJob.JobType IMPORT_EXCEL

    • EXPORT_EXCEL

      public static final EssJob.JobType EXPORT_EXCEL

    • LCM_BACKUP

      public static final EssJob.JobType LCM_BACKUP

    • LCM_RESTORE

      public static final EssJob.JobType LCM_RESTORE

    • BUILD_AGGREGATION

      public static final EssJob.JobType BUILD_AGGREGATION

    • CLEAR_AGGREGATIONS

      public static final EssJob.JobType CLEAR_AGGREGATIONS

    • EXPORT_DATA

      public static final EssJob.JobType EXPORT_DATA

    • RUN_MDX_SCRIPT

      public static final EssJob.JobType RUN_MDX_SCRIPT

    • UNKNOWN

      public static final EssJob.JobType UNKNOWN
      There is no "other" type for an Essbase job, but this gives us some wiggle room in case a new type is introduced, or we cannot otherwise properly parse the return type.

  • Method Details

    • values

      public static EssJob.JobType[] 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 EssJob.JobType 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

    • getParam

      public String getParam()
      Represents the name of the param used in the JSON request to the server. This is an instance of the JSON request format 'leaking' but it is what it is. Having this constant be accessible allows us to reference these consistently when putting together a job request.
      Returns:
      the parameter as used in the request payload to the job submission API

    • getResponseType

      public String getResponseType()
      The job type as it is returned from the job post API.
      Returns:
      the job type in the job execution response payload

    • parse

      public static EssJob.JobType parse(String textType)

    • toString

      public String toString()
      Overrides:
      toString in class Enum<EssJob.JobType>