Enum Constant and Description |
---|
CANCEL_PENDING |
CANCELLED |
COMPLETED |
COMPLETED_WITH_ERRORS |
COMPLETED_WITH_THRESHHOLD_EXCEPTION |
COMPLETED_WITH_WARNINGS |
ERROR |
PROCESSING |
UNKNOWN |
Modifier and Type | Method and Description |
---|---|
static JobStatus |
fromString(java.lang.String descriptiveStatus)
Get a JobStatus from a string.
|
java.lang.String |
getDescriptiveStatus()
Returns the name of this enum constant, as contained in the
declaration.
|
static JobStatus |
getJobStatus(int status)
Get a JobStatus from a int.
|
static java.util.Map<java.lang.Integer,java.lang.String> |
getJobStatusLabelMap(com.hyperion.planning.HspBaseMsgs hspMsgs)
Returns a map of job status id to the display label, for all the job
types.
|
int |
getStatus()
Returns the integer type of this enum constant, as contained in the
declaration.
|
java.lang.String |
getStatusLabelID()
Returns the label resource key for this job status.
|
boolean |
isError()
Returns true if this job status represents one of the error statuses.
|
java.lang.String |
toString() |
static JobStatus |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static JobStatus[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final JobStatus CANCEL_PENDING
public static final JobStatus CANCELLED
public static final JobStatus COMPLETED
public static final JobStatus COMPLETED_WITH_ERRORS
public static final JobStatus COMPLETED_WITH_THRESHHOLD_EXCEPTION
public static final JobStatus COMPLETED_WITH_WARNINGS
public static final JobStatus ERROR
public static final JobStatus PROCESSING
public static final JobStatus UNKNOWN
public static JobStatus fromString(java.lang.String descriptiveStatus)
descriptiveStatus
- String for a statusjava.lang.IllegalArgumentException
- if no JobStatus matches the specified
descriptiveStatuspublic java.lang.String getDescriptiveStatus()
public static JobStatus getJobStatus(int status)
status
- int for a given statusjava.lang.IllegalArgumentException
- if no JobStatus matches the specified
statuspublic static java.util.Map<java.lang.Integer,java.lang.String> getJobStatusLabelMap(com.hyperion.planning.HspBaseMsgs hspMsgs) throws java.lang.NoSuchFieldException, java.lang.IllegalAccessException
hspMsgs
- base messagesjava.lang.NoSuchFieldException
- if no display label is found for a job
statusjava.lang.IllegalAccessException
- if the display label is inaccessible in
the provided base messagespublic int getStatus()
public java.lang.String getStatusLabelID()
public boolean isError()
public java.lang.String toString()
toString
in class java.lang.Enum<JobStatus>
public static JobStatus valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static JobStatus[] values()
for (JobStatus c : JobStatus.values()) System.out.println(c);
Copyright © 2017, 2024, Oracle and/or its affiliates. All rights reserved.