com.evolveum.midpoint.model.api.hooks
Enum HookOperationMode

java.lang.Object
  extended by java.lang.Enum<HookOperationMode>
      extended by com.evolveum.midpoint.model.api.hooks.HookOperationMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HookOperationMode>

public enum HookOperationMode
extends java.lang.Enum<HookOperationMode>

Author:
semancik

Enum Constant Summary
BACKGROUND
          The hook operates in background.
ERROR
          Hook completes with an error (TODO).
FOREGROUND
          The hook operates in background.
 
Method Summary
static HookOperationMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static HookOperationMode[] 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

FOREGROUND

public static final HookOperationMode FOREGROUND
The hook operates in background. If the hook returns then the hook operation is completed. The caller reclaims ownership of the task. The thread may be used to continue execution of the task and to complete the task.


BACKGROUND

public static final HookOperationMode BACKGROUND
The hook operates in background. The hook will use its own thread for execution. After the hook is done with executing it will "return" control to the next handler in the task handler stack. The ownership of the task remains inside the hook. The thread returned from the hook method must be used only to return back to the caller (e.g. GUI) and inform him that the task was switched to background.


ERROR

public static final HookOperationMode ERROR
Hook completes with an error (TODO).

Method Detail

values

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

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

valueOf

public static HookOperationMode 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.