com.ibm.optim.oaas.client.job.model.JobExecutionStatus.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-java-client Show documentation

Java client API for DOCplexCloud, version 1.0.257

The newest version!







JobExecutionStatus (Java Client for DOcplexcloud 1.0 API)










Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Enum Constants | 
Field | 
Method


Detail: 
Enum Constants | 
Field | 
Method








com.ibm.optim.oaas.client.job.model
Enum JobExecutionStatus



java.lang.Object


java.lang.Enum<JobExecutionStatus>


com.ibm.optim.oaas.client.job.model.JobExecutionStatus









All Implemented Interfaces:
Serializable, Comparable<JobExecutionStatus>




public enum JobExecutionStatus
extends Enum<JobExecutionStatus>
Enumeration of job execution status values.











Enum Constant Summary

Enum Constants 

Enum Constant and Description


CREATED
The job has been created.



FAILED
The job had a system failure, with further details about the failure
 stored directly in the job.



INTERRUPTED
The job has been interrupted, with further details about the interruption
 stored directly in the job.



INTERRUPTING
A job interruption has been requested.



NOT_STARTED
The job has been sent to the execution queue and is ready to be picked by
 a worker.



PROCESSED
The job has been processed successfully at the system level.



RUNNING
The job has been picked by a worker and is being executed.










Method Summary

Methods 

Modifier and Type
Method and Description


static boolean
isActive(JobExecutionStatus jobStatus)
Check if the job is currently active based on the job status.



static boolean
isEnded(JobExecutionStatus jobStatus)
Check if the job execution has completed based on the job status.



static boolean
isFailure(JobExecutionStatus jobStatus)
Check if the job has completed its execution with a failure
 based on the job status.



static boolean
isWaiting(JobExecutionStatus jobStatus)
Check if the job is currently waiting to be processed based on the job status.



static JobExecutionStatus
valueOf(String name)
Returns the enum constant of this type with the specified name.



static JobExecutionStatus[]
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





CREATED
public static final JobExecutionStatus CREATED
The job has been created.







NOT_STARTED
public static final JobExecutionStatus NOT_STARTED
The job has been sent to the execution queue and is ready to be picked by
 a worker.







RUNNING
public static final JobExecutionStatus RUNNING
The job has been picked by a worker and is being executed.







INTERRUPTING
public static final JobExecutionStatus INTERRUPTING
A job interruption has been requested.







INTERRUPTED
public static final JobExecutionStatus INTERRUPTED
The job has been interrupted, with further details about the interruption
 stored directly in the job. See Job.getInterruptionStatus().







FAILED
public static final JobExecutionStatus FAILED
The job had a system failure, with further details about the failure
 stored directly in the job. See Job.getFailureInfo().







PROCESSED
public static final JobExecutionStatus PROCESSED
The job has been processed successfully at the system level.









Method Detail





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

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







valueOf
public static JobExecutionStatus valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null







isWaiting
public static boolean isWaiting(JobExecutionStatus jobStatus)
Check if the job is currently waiting to be processed based on the job status.
Parameters:
jobStatus - The job status.
Returns:
Returns true if the job is waiting to be processed,
         false otherwise.







isEnded
public static boolean isEnded(JobExecutionStatus jobStatus)
Check if the job execution has completed based on the job status.
Parameters:
jobStatus - The job status.
Returns:
Returns true if the job execution completed
         (processed, interrupted or failed), false otherwise.







isFailure
public static boolean isFailure(JobExecutionStatus jobStatus)
Check if the job has completed its execution with a failure
 based on the job status.
Parameters:
jobStatus - The job status.
Returns:
Returns true if the job completed execution with a
         failure, false otherwise.







isActive
public static boolean isActive(JobExecutionStatus jobStatus)
Check if the job is currently active based on the job status.
Parameters:
jobStatus - The job status.
Returns:
Returns true if the job is currently active,
         false otherwise.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Enum Constants | 
Field | 
Method


Detail: 
Enum Constants | 
Field | 
Method






Copyright © 2015–2017 IBM Corporation. Licensed under the Apache License, Version 2.0.

Modifier and Type	Method and Description
`static boolean`	`isActive(JobExecutionStatus jobStatus)` Check if the job is currently active based on the job status.
`static boolean`	`isEnded(JobExecutionStatus jobStatus)` Check if the job execution has completed based on the job status.
`static boolean`	`isFailure(JobExecutionStatus jobStatus)` Check if the job has completed its execution with a failure based on the job status.
`static boolean`	`isWaiting(JobExecutionStatus jobStatus)` Check if the job is currently waiting to be processed based on the job status.
`static JobExecutionStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static JobExecutionStatus[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.