public interface TaskletStatus
extends com.google.gwt.user.client.rpc.IsSerializable
Modifier and Type | Interface and Description |
---|---|
static class |
TaskletStatus.Scope
APP_SCOPE are cookies that are shared between all jobs runs and during job editing. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCookie(java.lang.String name,
TaskletStatus.Scope scope)
Cookies are Tasklet properties that are set by a Tasklet as it runs and made available
for viewing by a Tasklets GUIs (RuntimeViewer).
|
java.lang.Integer |
getCustomStatusCode()
Tasklet defined custom status code.
|
java.lang.String |
getCustomStatusMessage()
Tasklet defined custom status message.
|
java.util.Date |
getEndTime()
Date when Tasklets finished running.
|
java.util.Date |
getStartTime()
When Tasklet started running.
|
java.util.Date getStartTime()
java.util.Date getEndTime()
java.lang.Integer getCustomStatusCode()
java.lang.String getCustomStatusMessage()
java.lang.String getCookie(java.lang.String name, TaskletStatus.Scope scope)
Cookies are Tasklet properties that are set by a Tasklet as it runs and made available for viewing by a Tasklets GUIs (RuntimeViewer). This method returns both APP Scope scope and RUN Scope cookies.
The cookie properties are available to the RuntimeViewer GWT GUIs that are associated with a Tasklet. This allows developers to customize GWT GUIs to monitor progress and status reported by the Tasklet as the Tasklet runs. SeeIOViewerContext.fetchTaskletStatus()
for how to
request cookies and other Tasklet related properties from your RuntimeViewer GWT client.
Note, if you need to save and fetch complex data structures in the Cookie, for viewing by the RuntimeViewer, it is recommended you save the cookie as a serialized JSON string. This can then be parsed more efficiently by the GWT RuntimeViewer for display in the GUI.
name
- Name of the cookie to fetch.scope
- Type of cookie to fetch.Copyright © Grand Logic, Inc. All Rights Reserved.