com.ibm.workflow.servlet.client
Class JSPViewer

java.lang.Object
  |
  +--com.ibm.workflow.servlet.client.JSPViewer
All Implemented Interfaces:
Viewer

public class JSPViewer
extends java.lang.Object
implements Viewer

This Viewer should be used when your Application server supports the JSP V1.0 standard. It uses JSPs for custom process and activity forms as well as for some other commands. This provides much more flexibility than the propriatary HTML template files used by DefaultViewer and it also supports internationalization.

You must set DefaultViewer=com.ibm.worklflow.servlet.client.JSPViewer in the WebClient.properties file to in order to enable this Viewer.


Constructor Summary
JSPViewer()
           
 
Method Summary
 ResponsePage cancelWorkItemResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.cancelWorkItem() command.
 ResponsePage checkInWorkItemResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.checkInWorkItem() command.
 ResponsePage checkOutWorkItemResponse(RequestContext context)
          Creates the page that will be displayed when a work item has been checked out.
 ResponsePage createAndStartInstanceResponse(RequestContext context)
          Creates the page displayed after a new process instance has been created and started.
 ResponsePage createInstanceResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.createInstance() command.
 ResponsePage createListResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.createList() command.
 java.util.Vector createNavigatorEntries(RequestContext context, boolean enableLogoff)
           
 ResponsePage createPersistentListResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.createPersistentList() command.
 ResponsePage deleteInstanceResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.deleteInstance() command.
 ResponsePage deleteItemResponse(RequestContext context)
          Creates the page that is displayed when an item has been deleted.
 ResponsePage deleteListResponse(RequestContext context)
          Creates the page that is displayed when a list has been deleted.
 ResponsePage deleteTemplateResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.deleteTemplate() command.
 ResponsePage errorResponse(RequestContext context)
          Creates the page that is shown in case of an error.
 ResponsePage finishWorkItemResponse(RequestContext context)
          Creates the page that is displayed when a work item has been finished.
 ResponsePage forceFinishActivityResponse(RequestContext context)
          Creates the page that is displayed after an activity instance has been force finished.
 ResponsePage forceFinishWorkItemResponse(RequestContext context)
          Creates the page that is displayed after a work item has been force finished.
 ResponsePage forceRestartActivityResponse(RequestContext context)
          Creates the page that is displayed after an activity instance has been force restarted.
 ResponsePage forceRestartWorkItemResponse(RequestContext context)
          Creates the page that is displayed after a work item has been force restarted.
static void getContainerData(RequestContext context, java.lang.StringBuffer answer, java.lang.String contType, java.lang.String structName, com.ibm.workflow.api.ContainerElement[] elements, com.ibm.workflow.api.Container compData)
          Deprecated. - this function will be redesigned in a later release
 ResponsePage getFilterAssistantResponse(RequestContext context)
          Deprecated. - this function will be redesigned in a later release
 ResponsePage getSortCriteriaAssistantResponse(RequestContext context)
          Deprecated. - this function will be redesigned in a later release
 ResponsePage getSystemInfoResponse(RequestContext context)
          Deprecated. - this function will be redesigned in a later release
 ResponsePage getUserInfoResponse(RequestContext context)
          Deprecated. - this function will be redesigned in a later release
 void init(Config config)
          This method is called after the Web Client's servlet has been initialized.
 ResponsePage logoffResponse(RequestContext context)
          Creates the page that is shown after logoff.
 ResponsePage logonResponse(RequestContext context)
          Creates the page that is displayed after a successful logon.
 ResponsePage queryActivityInstancesResponse(RequestContext context)
          Creates the page that displays a list of activity instances.
 ResponsePage queryListsResponse(RequestContext context)
          Creates the page that displays the list of lists.
 ResponsePage queryProcessInstancesResponse(RequestContext context)
          Creates the page that displays a process instance list.
 ResponsePage queryProcessTemplatesResponse(RequestContext context)
          Creates the page that displays a process template list.
 ResponsePage queryWorkItemsResponse(RequestContext context)
          Creates the page that displays a worklist.
 ResponsePage restartInstanceResponse(RequestContext context)
          Creates the page displayed after a process instance has been restarted.
 ResponsePage restartWorkItemResponse(RequestContext context)
          Creates the page that is displayed when a work item has been restarted.
 ResponsePage resumeInstanceResponse(RequestContext context)
          Creates the page displayed after a process instance has been resumed.
 ResponsePage setListPropertiesResponse(RequestContext context)
          Creates the page that displays the list of lists.
 ResponsePage setUserSettingsResponse(RequestContext context)
           
 ResponsePage setViewSettingsResponse(RequestContext context)
          Deprecated. - this function will be redesigned in a later release
 ResponsePage showActivityPropertiesResponse(RequestContext context)
          Creates the page that displays activity instance properties.
 ResponsePage showControlConnectorPropertiesResponse(RequestContext context)
          Creates the page that displays control connector properties.
 ResponsePage showInstancePropertiesResponse(RequestContext context)
          Creates the page that displays process instance properties.
 ResponsePage showListPropertiesResponse(RequestContext context)
          Creates the page that displays list settings.
 ResponsePage showTemplatePropertiesResponse(RequestContext context)
          Creates the page that displays process template properties.
 ResponsePage showWorkItemPropertiesResponse(RequestContext context)
          Creates the page that displays work item properties.
 ResponsePage startInstanceResponse(RequestContext context)
          Creates the page that will be displayed after a process instance has been started.
 ResponsePage startWorkItemResponse(RequestContext context)
          Creates the page that is displayed when a work item has been started.
 ResponsePage suspendInstanceResponse(RequestContext context)
          Creates the page that is displayed after a process instance has been suspended.
 ResponsePage terminateActivityResponse(RequestContext context)
          Creates the page that is displayed after an activity instance has been terminated.
 ResponsePage terminateInstanceResponse(RequestContext context)
          Creates the page displayed after a process instance has been terminated.
 ResponsePage terminateWorkItemResponse(RequestContext context)
          Creates the page that is displayed when a work item has been terminated.
 ResponsePage transferItemResponse(RequestContext context)
          Creates the page that is displayed when an item has been transferred.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JSPViewer

public JSPViewer()
Method Detail

init

public void init(Config config)
Description copied from interface: Viewer
This method is called after the Web Client's servlet has been initialized. Here you can initialize your viewer class. For an example, look at DefaultViewer.java.
Specified by:
init in interface Viewer
Following copied from interface: com.ibm.workflow.servlet.client.Viewer
Parameters:
config - The servlet's configuration and initialization parameters

errorResponse

public ResponsePage errorResponse(RequestContext context)
Creates the page that is shown in case of an error. This method implements 'logon splicing'. In the case of an expired session, the original command will be remembered and executed after a successful re-logon.
Specified by:
errorResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.

logonResponse

public ResponsePage logonResponse(RequestContext context)
                           throws ClientException
Creates the page that is displayed after a successful logon. If this was a spliced logon page (see errorResponse(com.ibm.workflow.servlet.client.RequestContext)), the remembered command is extracted and executed. Otherwise, the first list is displayed. If no list is found, the page to create a new list will be returned.
Specified by:
logonResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

logoffResponse

public ResponsePage logoffResponse(RequestContext context)
Creates the page that is shown after logoff. This request will be forwarded to Logon.jsp.
Specified by:
logoffResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.

queryActivityInstancesResponse

public ResponsePage queryActivityInstancesResponse(RequestContext context)
                                            throws ClientException
Creates the page that displays a list of activity instances. This request will be forwarded to forms/ActivityList.jsp which dynamically creates a page that contains a table with a row for each activity on the list. This table also contains buttons that allow to invoke commands on the list entries
Parameters:
context - The request context.
Returns:
The response page or null if activity lists are disabled
Throws:
ClientException - if an error occurred

queryListsResponse

public ResponsePage queryListsResponse(RequestContext context)
                                throws ClientException
Creates the page that displays the list of lists. This request will be forwarded to forms/ListViewer.jsp which dynamically creates a page that contains a table with a row for each list on the list. This table also contains buttons that allow to invoke other commands, such as deleting a list.
Specified by:
queryListsResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page or null if lists of lists are disabled
Throws:
ClientException - if an error occurred

showListPropertiesResponse

public ResponsePage showListPropertiesResponse(RequestContext context)
                                        throws ClientException
Creates the page that displays list settings. This request will be forwarded to forms/ListPropertiesViewer.jsp.
Specified by:
showListPropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

setListPropertiesResponse

public ResponsePage setListPropertiesResponse(RequestContext context)
                                       throws ClientException
Creates the page that displays the list of lists. This request will be forwarded to forms/ListViewer.jsp which dynamically creates a page that contains a table with a row for each list.
Specified by:
setListPropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

createListResponse

public ResponsePage createListResponse(RequestContext context)
                                throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.createList() command.
Specified by:
createListResponse in interface Viewer
Following copied from interface: com.ibm.workflow.servlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

queryProcessTemplatesResponse

public ResponsePage queryProcessTemplatesResponse(RequestContext context)
                                           throws ClientException
Creates the page that displays a process template list. This request will be forwarded to forms/ListViewer.jsp which dynamically creates a page that contains a table with a row for each template on the list. This table also contains buttons that allow to invoke other commands, such as displaying a template's properties.
Specified by:
queryProcessTemplatesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page or null if template lists are disabled
Throws:
ClientException - if an error occurred

showTemplatePropertiesResponse

public ResponsePage showTemplatePropertiesResponse(RequestContext context)
                                            throws ClientException
Creates the page that displays process template properties. This request will be forwarded to forms/PropertiesViewer.jsp.
Specified by:
showTemplatePropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

createAndStartInstanceResponse

public ResponsePage createAndStartInstanceResponse(RequestContext context)
                                            throws ClientException
Creates the page displayed after a new process instance has been created and started.

If the process instance was not yet started because it required input data, the request will be forwarded to processes/TemplateName.jsp. This JSP should contain a form to fill in the required input container data and then again call BuiltinHandler.createAndStartInstance(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse). For a sample, see the credit request process. If the JSP file could not be found, the client tries to load file processes/TemplateName.html which may contain the following substitution variables:
Name Replacement
{_HTMLDir_} The root URI of the servlet's web application, for example, /MQWFClient.
{_MQWFServlet_} The servlet's name, for example, /MQWFClient/servlet/Main.
{_ActionArea_} A form containing a Submit button which calls createAndStartInstance again with the submitData request parameter set and with the input data entered, and a Cancel button which calls queryProcessTemplates to go back to the template list.
If the HTML template file cannot be found, and GenerateForms is set to true, a form is created from the process' input container. Submitting this form will start the instance with the data entered in the generated form.

If the process instance was started from a template list, this template list will be displayed next.

If the process instance was started by the web user, the page denoted by the SuccessLocation request parameter will be sent as response. If SuccessLocation is not set, the default form forms/ProcessStarted.html will be used. If additionally the UseRedirect request parameter is set to true, the request will be redirected to that page. If UseRedirect is false or not set, the page is loaded as an HTML template which may contain the following substitution variables:
Name Replacement
{_HTMLDir_} The root URI of the servlet's web application, for example, /MQWFClient.
{_MQWFServlet_} The servlet's name, for example, /MQWFClient/servlet/Main.
{_TemplateName_} The name of the process template.
{_InstanceName_} The name of the process instance that has been started.

If the process instance was started by the web user, the request will be forwarded to the page denoted by the SuccessLocation request parameter if it is a JSP. Note that this JSP must be in the same Web Application as the page containing the createAndStartInstance command. If it is not, you must additionally set the UseRedirect request parameter to true. In this case, the JSP will not have access to the RequestContext bean.

Specified by:
createAndStartInstanceResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

queryProcessInstancesResponse

public ResponsePage queryProcessInstancesResponse(RequestContext context)
                                           throws ClientException
Creates the page that displays a process instance list. This request will be forwarded to forms/ListViewer.jsp which dynamically creates a page that contains a table with a row for each instance on the list. This table also contains buttons that allow to invoke other commands, such as displaying an instance's properties.
Specified by:
queryProcessInstancesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page or null if template lists are disabled
Throws:
ClientException - if an error occurred

showInstancePropertiesResponse

public ResponsePage showInstancePropertiesResponse(RequestContext context)
                                            throws ClientException
Creates the page that displays process instance properties. This request will be forwarded to forms/PropertiesViewer.jsp.
Specified by:
showInstancePropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

startInstanceResponse

public ResponsePage startInstanceResponse(RequestContext context)
                                   throws ClientException
Creates the page that will be displayed after a process instance has been started. If the process instance was actually started, base class' startInstanceResponse method will be called. If the process instance was not yet started because it required input data, the request will be forwarded to processes/TemplateName.jsp, if this file exists.
Specified by:
startInstanceResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

suspendInstanceResponse

public ResponsePage suspendInstanceResponse(RequestContext context)
                                     throws ClientException
Creates the page that is displayed after a process instance has been suspended. If the process instance was actually suspended, the most recent list will be displayed. If it has not yet been suspended because the necessary data has not been specified, the request will be forwarded to forms/SuspendInstance.jsp so the parameters for the suspendInstance command can be specified.
Specified by:
suspendInstanceResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

showActivityPropertiesResponse

public ResponsePage showActivityPropertiesResponse(RequestContext context)
                                            throws ClientException
Creates the page that displays activity instance properties. This request will be forwarded to forms/PropertiesViewer.jsp.
Specified by:
showActivityPropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

forceRestartActivityResponse

public ResponsePage forceRestartActivityResponse(RequestContext context)
                                          throws ClientException
Creates the page that is displayed after an activity instance has been force restarted. If the activity instance was actually force restarted, the request will be forwarded to forms/PropertiesViewer.jsp (this is the only page from where activities can be force restarted). If it has not yet been force restarted because the necessary data has not been specified, the request will be forwarded to forms/ForceRestart.jsp so the parameters for the forceRestartActivity command can be specified.
Specified by:
forceRestartActivityResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

forceFinishActivityResponse

public ResponsePage forceFinishActivityResponse(RequestContext context)
                                         throws ClientException
Creates the page that is displayed after an activity instance has been force finished. If the activity instance was actually force finished, the request will be forwarded to forms/PropertiesViewer.jsp if the action was called from the properties page. Otherwise it was called from an activity instance page. In this case the folowing page is the list itself. If it has not yet been force finished because the necessary data has not been specified, the request will be forwarded to forms/ForceFinish.jsp so the parameters for the forceFinishActivity command can be specified.
Specified by:
forceFinishActivityResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

terminateActivityResponse

public ResponsePage terminateActivityResponse(RequestContext context)
                                       throws ClientException
Creates the page that is displayed after an activity instance has been terminated. This request will be forwarded to forms/PropertiesViewer.jsp (this is the only page from where activities can be terminated).
Specified by:
terminateActivityResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

showControlConnectorPropertiesResponse

public ResponsePage showControlConnectorPropertiesResponse(RequestContext context)
                                                    throws ClientException
Creates the page that displays control connector properties. This request will be forwarded to forms/PropertiesViewer.jsp.
Specified by:
showControlConnectorPropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

queryWorkItemsResponse

public ResponsePage queryWorkItemsResponse(RequestContext context)
                                    throws ClientException
Creates the page that displays a worklist. This request will be forwarded to forms/ListViewer.jsp which dynamically creates a page that contains a table with a row for each work item on the list. This table also contains buttons that allow to invoke other commands, such as displaying an item's properties.
Specified by:
queryWorkItemsResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page or null if template lists are disabled
Throws:
ClientException - if an error occurred

showWorkItemPropertiesResponse

public ResponsePage showWorkItemPropertiesResponse(RequestContext context)
                                            throws ClientException
Creates the page that displays work item properties. This request will be forwarded to forms/PropertiesViewer.jsp.
Specified by:
showWorkItemPropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

checkOutWorkItemResponse

public ResponsePage checkOutWorkItemResponse(RequestContext context)
                                      throws ClientException
Creates the page that will be displayed when a work item has been checked out.

This request will be forwarded to programs/ProgramName.jsp (where ProgramName is the name of the program assigned to the activity). This JSP should contain a form to fill in the required input container data and then call BuiltinHandler.checkInWorkItem(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse). For a sample, see the credit request process. If the JSP file could not be found, the request will try to load programs/ProgramName.html (where ProgramName is the name of the program assigned to the activity). This HTML template file may contain the following substitution variables:
Name Replacement
{_HTMLDir_} The root URI of the servlet's web application, for example, /MQWFClient.
{_MQWFServlet_} The servlet's name, for example, /MQWFClient/servlet/Main.
{_Date_} The current date.
{_Time_} The current time.
{_Name_} The name of the work item.
{_Description_} The description of the work item.
{_UserID_} The owner of the work item.
{_ActionArea_} A form containing a Submit button which calls checkInWorkItem with the input data entered and a Cancel button which calls cancelWorkItem.
If the HTML template file cannot be found, and GenerateForms is set to true, a form is created from the work item's input container. Submitting this form will check in the work item with the data entered in the generated form.

Specified by:
checkOutWorkItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

forceFinishWorkItemResponse

public ResponsePage forceFinishWorkItemResponse(RequestContext context)
                                         throws ClientException
Creates the page that is displayed after a work item has been force finished. If the work item was actually force finished, the most recent lists is displayed. If it has not yet been force finished because the necessary data has not been specified, the request will be forwarded to forms/ForceFinish.jsp so the parameters for the forceFinishWorkItem command can be specified.
Specified by:
forceFinishWorkItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

forceRestartWorkItemResponse

public ResponsePage forceRestartWorkItemResponse(RequestContext context)
                                          throws ClientException
Creates the page that is displayed after a work item has been force restarted. If the work item was actually force restarted, the most recent lists is displayed. If it has not yet been force restarted because the necessary data has not been specified, the request will be forwarded to forms/ForceRestart.jsp so the parameters for the forceRestartWorkItem command can be specified.
Specified by:
forceRestartWorkItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

getFilterAssistantResponse

public ResponsePage getFilterAssistantResponse(RequestContext context)
                                        throws ClientException
Deprecated. - this function will be redesigned in a later release

Specified by:
getFilterAssistantResponse in interface Viewer

getSortCriteriaAssistantResponse

public ResponsePage getSortCriteriaAssistantResponse(RequestContext context)
                                              throws ClientException
Deprecated. - this function will be redesigned in a later release


getUserInfoResponse

public ResponsePage getUserInfoResponse(RequestContext context)
                                 throws ClientException
Deprecated. - this function will be redesigned in a later release

Specified by:
getUserInfoResponse in interface Viewer

getSystemInfoResponse

public ResponsePage getSystemInfoResponse(RequestContext context)
                                   throws ClientException
Deprecated. - this function will be redesigned in a later release

Specified by:
getSystemInfoResponse in interface Viewer

createNavigatorEntries

public java.util.Vector createNavigatorEntries(RequestContext context,
                                               boolean enableLogoff)
                                        throws ClientException

setUserSettingsResponse

public ResponsePage setUserSettingsResponse(RequestContext context)
                                     throws ClientException
Specified by:
setUserSettingsResponse in interface Viewer

deleteTemplateResponse

public ResponsePage deleteTemplateResponse(RequestContext context)
                                    throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.deleteTemplate() command.
Specified by:
deleteTemplateResponse in interface Viewer
Following copied from interface: com.ibm.workflow.servlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

cancelWorkItemResponse

public ResponsePage cancelWorkItemResponse(RequestContext context)
                                    throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.cancelWorkItem() command.
Specified by:
cancelWorkItemResponse in interface Viewer
Following copied from interface: com.ibm.workflow.servlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

checkInWorkItemResponse

public ResponsePage checkInWorkItemResponse(RequestContext context)
                                     throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.checkInWorkItem() command.
Specified by:
checkInWorkItemResponse in interface Viewer
Following copied from interface: com.ibm.workflow.servlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

createInstanceResponse

public ResponsePage createInstanceResponse(RequestContext context)
                                    throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.createInstance() command.
Specified by:
createInstanceResponse in interface Viewer
Following copied from interface: com.ibm.workflow.servlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

createPersistentListResponse

public ResponsePage createPersistentListResponse(RequestContext context)
                                          throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.createPersistentList() command.
Specified by:
createPersistentListResponse in interface Viewer
Following copied from interface: com.ibm.workflow.servlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

deleteInstanceResponse

public ResponsePage deleteInstanceResponse(RequestContext context)
                                    throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.deleteInstance() command.
Specified by:
deleteInstanceResponse in interface Viewer
Following copied from interface: com.ibm.workflow.servlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

deleteItemResponse

public ResponsePage deleteItemResponse(RequestContext context)
                                throws ClientException
Creates the page that is displayed when an item has been deleted. This page calls BuiltinHandler.queryWorkItems() to show the work list again.
Specified by:
deleteItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

deleteListResponse

public ResponsePage deleteListResponse(RequestContext context)
                                throws ClientException
Creates the page that is displayed when a list has been deleted. This page calls BuiltinHandler.queryLists() to show the list of lists again.
Specified by:
deleteListResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

finishWorkItemResponse

public ResponsePage finishWorkItemResponse(RequestContext context)
                                    throws ClientException
Creates the page that is displayed when a work item has been finished. This page calls BuiltinHandler.queryWorkItems() to show the work list again.
Specified by:
finishWorkItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

restartInstanceResponse

public ResponsePage restartInstanceResponse(RequestContext context)
                                     throws ClientException
Creates the page displayed after a process instance has been restarted. This page calls BuiltinHandler.queryProcessInstances()
Specified by:
restartInstanceResponse in interface Viewer
Parameters:
context - the request context
Returns:
The response page.
Throws:
ClientException - if an error occurred

restartWorkItemResponse

public ResponsePage restartWorkItemResponse(RequestContext context)
                                     throws ClientException
Creates the page that is displayed when a work item has been restarted. This page calls BuiltinHandler.queryWorkItems() to show the work list again.
Specified by:
restartWorkItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

resumeInstanceResponse

public ResponsePage resumeInstanceResponse(RequestContext context)
                                    throws ClientException
Creates the page displayed after a process instance has been resumed. This page calls BuiltinHandler.queryProcessInstances() to show the instance list again.
Specified by:
resumeInstanceResponse in interface Viewer
Parameters:
context - the request context
Returns:
The response page.
Throws:
ClientException - if an error occurred

setViewSettingsResponse

public ResponsePage setViewSettingsResponse(RequestContext context)
                                     throws ClientException
Deprecated. - this function will be redesigned in a later release

Specified by:
setViewSettingsResponse in interface Viewer

startWorkItemResponse

public ResponsePage startWorkItemResponse(RequestContext context)
                                   throws ClientException
Creates the page that is displayed when a work item has been started. This page calls BuiltinHandler.queryWorkItems() to show the work list again.
Specified by:
startWorkItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

terminateWorkItemResponse

public ResponsePage terminateWorkItemResponse(RequestContext context)
                                       throws ClientException
Creates the page that is displayed when a work item has been terminated. This page calls BuiltinHandler.queryWorkItems() to show the work list again.
Specified by:
terminateWorkItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

terminateInstanceResponse

public ResponsePage terminateInstanceResponse(RequestContext context)
                                       throws ClientException
Creates the page displayed after a process instance has been terminated. This page calls BuiltinHandler.queryProcessInstances() to show the instance list again.
Specified by:
terminateInstanceResponse in interface Viewer
Parameters:
context - the request context
Returns:
The response page.
Throws:
ClientException - if an error occurred

transferItemResponse

public ResponsePage transferItemResponse(RequestContext context)
                                  throws ClientException
Creates the page that is displayed when an item has been transferred. If the item was transferred, the work list will be shown again. If the item was not yet transferred because the user ID to transfer to was not specified, the HTML template file forms/Transfer.html will be loaded which may contain the following substitution variables:
Name Replacement
{_HTMLDir_} The root URI of the servlet's web application, for example, /MQWFClient.
{_MQWFServlet_} The servlet's name, for example, /MQWFClient/servlet/Main.
{_Oid_} The OID of the item that is to be transferred.
{_ItemName_} The name of the item that is to be transferred.
Specified by:
transferItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

getContainerData

public static void getContainerData(RequestContext context,
                                    java.lang.StringBuffer answer,
                                    java.lang.String contType,
                                    java.lang.String structName,
                                    com.ibm.workflow.api.ContainerElement[] elements,
                                    com.ibm.workflow.api.Container compData)
Deprecated. - this function will be redesigned in a later release



© Copyright IBM Corporation 1999, 2007. All Rights Reserved.