Package com.evolveum.midpoint.gui.impl.page.admin.abstractrole.component

Class TaskAwareExecutor

java.lang.Object

com.evolveum.midpoint.gui.impl.page.admin.abstractrole.component.TaskAwareExecutor

@Experimental
public class TaskAwareExecutor
extends Object

Executes arbitrary code that needs a Task and an OperationResult. Creates a task, executes the code, and then handles any errors. Displays the operation result. Created to avoid repeating these actions throughout GUI code. This class is NOT SERIALIZABLE (although it probably could be made so); neither the instances of TaskAwareExecutor.Executable and TaskAwareExecutor.ExecutableVoid are. Please do not store these objects in Wicket components (directly or indirectly). TODO the treatment of "void" methods is not good now (two methods + ugly names); to be improved

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TaskAwareExecutor.Executable<T>
static interface	TaskAwareExecutor.ExecutableVoid

Constructor Summary

Constructors

Constructor	Description
TaskAwareExecutor(@NotNull PageBase pageBase, @NotNull org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget, @NotNull String operation)

Method Summary

Modifier and Type	Method	Description
TaskAwareExecutor	hideSuccessfulStatus()	If true, only non-success status is shown (in feedback panel).
<X> X	run(@NotNull TaskAwareExecutor.Executable<X> executable)	Returns `null` in case of error; even in cases where the original TaskAwareExecutor.Executable.execute(Task, OperationResult) _implementation_ is marked as `@NotNull`.
void	runVoid(@NotNull TaskAwareExecutor.ExecutableVoid executable)	TODO better name
TaskAwareExecutor	withCustomFeedbackPanel(org.apache.wicket.Component panel)	If the feedback panel is different from the default one.
TaskAwareExecutor	withOpResultOptions(OpResult.Options options)	Options for rendering the operation result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TaskAwareExecutor

public TaskAwareExecutor(@NotNull
 @NotNull PageBase pageBase,
 @NotNull
 @NotNull org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
 @NotNull
 @NotNull String operation)

Method Details

hideSuccessfulStatus

public TaskAwareExecutor hideSuccessfulStatus()

If true, only non-success status is shown (in feedback panel).

withOpResultOptions

public TaskAwareExecutor withOpResultOptions(OpResult.Options options)

Options for rendering the operation result.

withCustomFeedbackPanel

public TaskAwareExecutor withCustomFeedbackPanel(org.apache.wicket.Component panel)

If the feedback panel is different from the default one.

run

@Nullable
public <X> X run(@NotNull
 @NotNull TaskAwareExecutor.Executable<X> executable)

Returns `null` in case of error; even in cases where the original TaskAwareExecutor.Executable.execute(Task, OperationResult) _implementation_ is marked as `@NotNull`.

runVoid

public void runVoid(@NotNull
 @NotNull TaskAwareExecutor.ExecutableVoid executable)

TODO better name