com.evolveum.midpoint.task.api
Enum TaskRunResult.TaskRunResultStatus

java.lang.Object
  extended by java.lang.Enum<TaskRunResult.TaskRunResultStatus>
      extended by com.evolveum.midpoint.task.api.TaskRunResult.TaskRunResultStatus
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TaskRunResult.TaskRunResultStatus>
Enclosing class:
TaskRunResult

public static enum TaskRunResult.TaskRunResultStatus
extends java.lang.Enum<TaskRunResult.TaskRunResultStatus>


Enum Constant Summary
FINISHED
          The task run has finished.
IN_PROGRESS
          Task run haven't finished.
PERMANENT_ERROR
          The run has failed.
TEMPORARY_ERROR
          Temporary failure during the run.
 
Method Summary
static TaskRunResult.TaskRunResultStatus valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static TaskRunResult.TaskRunResultStatus[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FINISHED

public static final TaskRunResult.TaskRunResultStatus FINISHED
The task run has finished. This does not necessarily mean that the task itself is finished. For single tasks this means that the task is finished, but it is different for reccurent tasks. The task may be a cycle and it will run again after it sleeps for a while. Or it may be other type of recurrent task.


IN_PROGRESS

public static final TaskRunResult.TaskRunResultStatus IN_PROGRESS
Task run haven't finished. It is executed in a different thread or on a different system. TODO: do we need it? Is it correct?


PERMANENT_ERROR

public static final TaskRunResult.TaskRunResultStatus PERMANENT_ERROR
The run has failed. The error is permanent. Unless the administrator does something to recover from the situation, there is no point in re-trying the run. Usual case of this error is task miscofiguration.


TEMPORARY_ERROR

public static final TaskRunResult.TaskRunResultStatus TEMPORARY_ERROR
Temporary failure during the run. The error is temporary. The situation may change later when the conditions will be more "favorable". It makes sense to retry the run. Usual cases of this error are network timeouts.

Method Detail

values

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

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

valueOf

public static TaskRunResult.TaskRunResultStatus 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


Copyright © 2012 evolveum. All Rights Reserved.