com.mindoo.remote.api.jobs
Interface IRemoteMonitoringJob

All Superinterfaces:

IRemoteJob

public interface IRemoteMonitoringJob
extends IRemoteJob

Interface of a Job that can be used to visualize progress and status information (e.g. in a progress dialog). The job is running until the method IRemoteProgressMonitor.done() is called on the progress monitor returned by getProgressMonitor()

A use case for this method is long running background code execution, e.g. XPages SSJS, that needs a visualization in the UI

Method Summary

IRemoteProgressMonitor

getProgressMonitor() Returns a progress monitor object to update progress and status information, check for job cancellation and finally call IRemoteProgressMonitor.done() when the code execution is done

Methods inherited from interface com.mindoo.remote.api.jobs.IRemoteJob

isSystem, isUser, schedule, setProperty, setSystem, setUser

Method Detail

getProgressMonitor

IRemoteProgressMonitor getProgressMonitor()
                                          throws RemoteEclipseAPIException

Returns a progress monitor object to update progress and status information, check for job cancellation and finally call IRemoteProgressMonitor.done() when the code execution is done

Returns:

progress monitor

Throws:

RemoteEclipseAPIException