de.esprit.netsuite.rtask

Class RemoteTaskMonitor<S extends ServerContext>

java.lang.Object

de.esprit.common.util.DumpableObject

de.esprit.appsuite.launch.AbstractApplicationObject<C>

de.esprit.appsuite.task.monitor.AbstractTaskMonitor<S>

de.esprit.netsuite.rtask.RemoteTaskMonitor<S>

All Implemented Interfaces:

ApplicationObject<S>, TaskMonitor<S>, SimpleLogSupport, Dumpable, ServerObject<S>

Direct Known Subclasses:

JournalTaskMonitor

public class RemoteTaskMonitor<S extends ServerContext>
extends AbstractTaskMonitor<S>
implements ServerObject<S>

This TaskMonitor sends RemoteTaskEvents to the client for synchronization. It may be attached to any RemoteTask instance.

Author:

Rainer Buesch

Constructor Summary

Constructors

Constructor and Description
RemoteTaskMonitor(S serverCtx)
RemoteTaskMonitor(S serverCtx, LogChannel logCh)

Method Summary

Methods

Modifier and Type	Method and Description
S	getServerContext() Returns the server runtime environment
protected void	sendRemoteTaskEvent(RemoteTaskEvent event)
void	taskCancelled(RunStateFlag stateFlag) Called when the async task has discovered that it was cancelled
void	taskChildFinished(RunStateFlag stateFlag) Indicates that a child task has been finished.
void	taskChildStarted(RunStateFlag stateFlag) Indicates that a child task has been started.
void	taskChildSucceeded(RunStateFlag stateFlag, java.lang.Object result) Indicates that a child task has been succeeded with the given result.
void	taskFailed(RunStateFlag stateFlag, java.lang.Exception error) Called when the async task failed
void	taskFinished(RunStateFlag stateFlag) Called when the async task finished
void	taskProceeded(RunStateFlag stateFlag, java.lang.Object result, int step, int maxSteps, java.lang.String message) Is called on task progress.
void	taskStarted(RunStateFlag stateFlag) Called when the async task started
void	taskSucceeded(RunStateFlag stateFlag, java.lang.Object result) Called when the async task succeeded

Methods inherited from class de.esprit.appsuite.task.monitor.AbstractTaskMonitor

accept

Methods inherited from class de.esprit.appsuite.launch.AbstractApplicationObject

getApplicationContext, getLogChannel, isLogDebug, isLogVerbose, logDebug, logDump, logError, logError, logFatal, logInfo, logVerbose, logWarning, setLogChannel

Methods inherited from class de.esprit.common.util.DumpableObject

configureDumpHeadlineLength, configureDumpMaxElementsPrinted, copyDumpStringValues, copyToStringValues, createDumpHeader, toDumpString, toDumpString, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.esprit.appsuite.launch.ApplicationObject

getApplicationContext

Constructor Detail

RemoteTaskMonitor

public RemoteTaskMonitor(S serverCtx)

RemoteTaskMonitor

public RemoteTaskMonitor(S serverCtx,
                 LogChannel logCh)

Method Detail

getServerContext

public final S getServerContext()

Description copied from interface: ServerObject

Returns the server runtime environment

Specified by:

getServerContext in interface ServerObject<S extends ServerContext>

taskStarted

public void taskStarted(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Called when the async task started

Specified by:

taskStarted in interface TaskMonitor<S extends ServerContext>

taskProceeded

public void taskProceeded(RunStateFlag stateFlag,
                 java.lang.Object result,
                 int step,
                 int maxSteps,
                 java.lang.String message)

Description copied from interface: TaskMonitor

Is called on task progress.

Specified by:

taskProceeded in interface TaskMonitor<S extends ServerContext>

result - may be anything the running task has produced (i.e. a DBRecord)

step - the number of steps performed

maxSteps - the maximum number of steps expected (0 if not known)

taskSucceeded

public void taskSucceeded(RunStateFlag stateFlag,
                 java.lang.Object result)

Description copied from interface: TaskMonitor

Called when the async task succeeded

Specified by:

taskSucceeded in interface TaskMonitor<S extends ServerContext>

taskCancelled

public void taskCancelled(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Called when the async task has discovered that it was cancelled

Specified by:

taskCancelled in interface TaskMonitor<S extends ServerContext>

taskFailed

public void taskFailed(RunStateFlag stateFlag,
              java.lang.Exception error)

Description copied from interface: TaskMonitor

Called when the async task failed

Specified by:

taskFailed in interface TaskMonitor<S extends ServerContext>

taskFinished

public void taskFinished(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Called when the async task finished

Specified by:

taskFinished in interface TaskMonitor<S extends ServerContext>

taskChildStarted

public void taskChildStarted(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Indicates that a child task has been started. Note that the child's taskId will be available from the RunState's taskId by RunStateFlag.getCurrentChild();

Specified by:

taskChildStarted in interface TaskMonitor<S extends ServerContext>

taskChildSucceeded

public void taskChildSucceeded(RunStateFlag stateFlag,
                      java.lang.Object result)

Description copied from interface: TaskMonitor

Indicates that a child task has been succeeded with the given result.

Specified by:

taskChildSucceeded in interface TaskMonitor<S extends ServerContext>

taskChildFinished

public void taskChildFinished(RunStateFlag stateFlag)

Description copied from interface: TaskMonitor

Indicates that a child task has been finished.

Specified by:

taskChildFinished in interface TaskMonitor<S extends ServerContext>

sendRemoteTaskEvent

protected void sendRemoteTaskEvent(RemoteTaskEvent event)