com.ibm.workflow.portlet.client
Class DefaultViewer

java.lang.Object
  |
  +--com.ibm.workflow.portlet.client.DefaultViewer
All Implemented Interfaces:
java.io.Serializable, Viewer
Direct Known Subclasses:
InternetConnectionViewer, JSPPortletViewer, JSPViewer

public class DefaultViewer
extends java.lang.Object
implements Viewer, java.io.Serializable

This class provides the default implementation of the Viewer interface. Extend this class if you want to change the appearance of only some response pages.
For some commands, the response pages are created dynamically (such as queryWorkItemsResponse()). For others, a static HTML file is loaded (for example, showTemplatePropertiesResponse()). There are also methods that simply forward to other methods - for example, createInstanceResponse() refers to queryProcessTemplatesResponse() so that when a new process instance has been created from the template list, the template list is displayed again.

See Also:
Serialized Form

Constructor Summary
DefaultViewer()
           
 
Method Summary
 ResponsePage cancelWorkItemResponse(RequestContext context)
          Creates the page that is displayed when a work item checkout has been canceled.
 ResponsePage checkInWorkItemResponse(RequestContext context)
          Creates the page that is displayed when a work item has been checked in.
 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)
          Creates the page displayed after a new process instance has been created.
 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)
          This method is called to initialize the Navigation entries for the list views
 ResponsePage createPersistentListResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.createPersistentList() command.
 ResponsePage deleteInstanceResponse(RequestContext context)
          Creates the page displayed after a process instance has been deleted.
 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)
          Creates the page displayed after a process template has been deleted.
 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)
          This method has an empty implementation since activity actions can only be accessed from activity properties page which requires JSPPortletViewer.
 ResponsePage forceFinishWorkItemResponse(RequestContext context)
          Creates the page that is displayed when a work item has been force finished.
 ResponsePage forceRestartActivityResponse(RequestContext context)
          This method has an empty implementation since activity actions can only be accessed from activity properties page which requires JSPPortletViewer.
 ResponsePage forceRestartWorkItemResponse(RequestContext context)
          Creates the page that is displayed when 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 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)
          Initializes this class according to the [DefaultViewer] section in the servlet configuration file.
 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)
           
 ResponsePage queryListsResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.queryLists() command.
 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 work list.
 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)
          This method is called to create the response page for the BuiltinHandler.setListProperties() command.
 ResponsePage setUserSettingsResponse(RequestContext context)
          Deprecated. - this function will be redesigned in a later release
 ResponsePage setViewSettingsResponse(RequestContext context)
          Deprecated. - this function will be redesigned in a later release
 ResponsePage showActivityPropertiesResponse(RequestContext context)
          This method has an empty implementation since activity properties can only be accessed from within the process monitor which requires JSPPortletViewer.
 ResponsePage showControlConnectorPropertiesResponse(RequestContext context)
          This method has an empty implementation since connector properties can only be accessed from within the process monitor which requires JSPPortletViewer.
 ResponsePage showInstancePropertiesResponse(RequestContext context)
          Creates the page that displays process instance properties.
 ResponsePage showListPropertiesResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.showListProperties() command.
 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 displayed after a process instance has been suspended.
 ResponsePage terminateActivityResponse(RequestContext context)
          This method has an empty implementation since activity actions can only be accessed from activity properties page which requires JSPPortletViewer.
 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

DefaultViewer

public DefaultViewer()
Method Detail

init

public void init(Config config)
Initializes this class according to the [DefaultViewer] section in the servlet configuration file.
Specified by:
init in interface Viewer
Parameters:
config - the servlet configuration.

errorResponse

public ResponsePage errorResponse(RequestContext context)
Creates the page that is shown in case of an error. This page will be loaded from forms/Error.html and allows 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.
{_Title_} The page title.
{_Message_} The error message.
{_StackTrace_} The Java stack trace.
If the HTML template file cannot be loaded, an error page will be dynamically created.
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 there are worklists and the the display of work items is enabled, the first worklist will be shown. Otherwise, if there are template lists and the display of templates is enabled, the first template list will be shown. Otherwise, if there are instance lists and the display of process instances is enabled, the first instance list will be shown. If nothing is enabled that is available, an exception will be thrown.
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 is the page specified by the PageAfterLogoff setting in the PortalClient.properties configuration file.
Specified by:
logoffResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.

queryListsResponse

public ResponsePage queryListsResponse(RequestContext context)
                                throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.queryLists() command.
Specified by:
queryListsResponse in interface Viewer
Parameters:
context - The request context.
Returns:
null.
Throws:
ClientException - if an error occurred

showListPropertiesResponse

public ResponsePage showListPropertiesResponse(RequestContext context)
                                        throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.showListProperties() command.
Specified by:
showListPropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
null.
Throws:
ClientException - if an error occurred

setListPropertiesResponse

public ResponsePage setListPropertiesResponse(RequestContext context)
                                       throws ClientException
Description copied from interface: Viewer
This method is called to create the response page for the BuiltinHandler.setListProperties() command.
Specified by:
setListPropertiesResponse in interface Viewer
Following copied from interface: com.ibm.workflow.portlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
com.ibm.workflow.servlet.client.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

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.portlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
com.ibm.workflow.servlet.client.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.portlet.client.Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
com.ibm.workflow.servlet.client.ClientException - If an error occurred.

queryProcessTemplatesResponse

public ResponsePage queryProcessTemplatesResponse(RequestContext context)
                                           throws ClientException
Creates the page that displays a process template list. This page is dynamically created and 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 page will be loaded from forms/TemplateProperties.html and allows 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.
{Name} The template name.
{Description} The template description.
{Category} The category of the template.
{InputDataStructure} The name of the template's input data structure.
{OutputDataStructure} The name of the template's output data structure.
{ProcessAdmin} The process administrator.
{Role} The process' role.
{Organization} The process' organization.
{Documentation} The template documentation.
{_ActionArea_} A form containing the Back button.
Specified by:
showTemplatePropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

createInstanceResponse

public ResponsePage createInstanceResponse(RequestContext context)
                                    throws ClientException
Creates the page displayed after a new process instance has been created. This page calls BuiltinHandler.queryProcessTemplates() to show the template list again.
Specified by:
createInstanceResponse 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, an HTML template will be loaded from 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.

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

deleteTemplateResponse

public ResponsePage deleteTemplateResponse(RequestContext context)
                                    throws ClientException
Creates the page displayed after a process template has been deleted. This page calls BuiltinHandler.queryProcessTemplates() to show the template list again.
Specified by:
deleteTemplateResponse 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 page is dynamically created and 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.
Throws:
ClientException - if an error occurred

showInstancePropertiesResponse

public ResponsePage showInstancePropertiesResponse(RequestContext context)
                                            throws ClientException
Creates the page that displays process instance properties. This page will be loaded from forms/InstanceProperties.html and allows 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.
{Name} The instance name.
{Description} The instance description.
{Category} The category of the instance.
{State} The process state.
{ParentName} The parent process name.
{TopLevelName} The top level process name.
{InputDataStructure} The name of the template's input data structure.
{OutputDataStructure} The name of the template's output data structure.
{Starter} The process starter.
{ProcessAdmin} The process administrator.
{Role} The process' role.
{Organization} The process' organization.
{Documentation} The process documentation.
{Received} The process start time.
{Notification} The process notification time.
{Finished} The process end time.
{_ActionArea_} A form containing the Back button.
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, the instance list will be shown again. If the process instance was not yet started because it required input data, an HTML template will be loaded from 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 startInstance with the input data entered and a Cancel button which calls queryProcessInstances to go back to the instance 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.
Specified by:
startInstanceResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

deleteInstanceResponse

public ResponsePage deleteInstanceResponse(RequestContext context)
                                    throws ClientException
Creates the page displayed after a process instance has been deleted. This page calls BuiltinHandler.queryProcessInstances() to show the instance list again.
Specified by:
deleteInstanceResponse 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 displayed after a process instance has been suspended. If the process instance was actually suspended, this method simply calls the queryProcessInstancesResponse() method. If the instance was not yet suspended because the necessary data has not yet been specified, it will be suspended first with the deep parameter set to true and no 'until' date specified.
Specified by:
suspendInstanceResponse 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

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

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

showActivityPropertiesResponse

public ResponsePage showActivityPropertiesResponse(RequestContext context)
                                            throws ClientException
This method has an empty implementation since activity properties can only be accessed from within the process monitor which requires JSPPortletViewer.
Specified by:
showActivityPropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
null.
Throws:
ClientException - if an error occurred

forceRestartActivityResponse

public ResponsePage forceRestartActivityResponse(RequestContext context)
                                          throws ClientException
This method has an empty implementation since activity actions can only be accessed from activity properties page which requires JSPPortletViewer.
Specified by:
forceRestartActivityResponse in interface Viewer
Parameters:
context - The request context.
Returns:
null.
Throws:
ClientException - if an error occurred

forceFinishActivityResponse

public ResponsePage forceFinishActivityResponse(RequestContext context)
                                         throws ClientException
This method has an empty implementation since activity actions can only be accessed from activity properties page which requires JSPPortletViewer.
Specified by:
forceFinishActivityResponse in interface Viewer
Parameters:
context - The request context.
Returns:
null.
Throws:
ClientException - if an error occurred

terminateActivityResponse

public ResponsePage terminateActivityResponse(RequestContext context)
                                       throws ClientException
This method has an empty implementation since activity actions can only be accessed from activity properties page which requires JSPPortletViewer.
Specified by:
terminateActivityResponse in interface Viewer
Parameters:
context - The request context.
Returns:
null.
Throws:
ClientException - if an error occurred

showControlConnectorPropertiesResponse

public ResponsePage showControlConnectorPropertiesResponse(RequestContext context)
                                                    throws ClientException
This method has an empty implementation since connector properties can only be accessed from within the process monitor which requires JSPPortletViewer.
Specified by:
showControlConnectorPropertiesResponse in interface Viewer
Parameters:
context - The request context.
Returns:
null.
Throws:
ClientException - if an error occurred

queryWorkItemsResponse

public ResponsePage queryWorkItemsResponse(RequestContext context)
                                    throws ClientException
Creates the page that displays a work list. This page is dynamically created and contains a table with a row for each 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.
Throws:
ClientException - if an error occurred

showWorkItemPropertiesResponse

public ResponsePage showWorkItemPropertiesResponse(RequestContext context)
                                            throws ClientException
Creates the page that displays work item properties. This page will be loaded from forms/WorkItemProperties.html and allows 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.
{Name} The item name.
{Description} The item description.
{State} The item state.
{Type} The item type.
{ProgramActivity} The item implementation.
{ReceivedAs} Why the item was assigned.
{ProcessName} The parent process name.
{Category} The item category.
{Start} The activity's start mode.
{StartCondition} The activity's start condition.
{Exit} The activity's exit mode.
{ExitCondition} The activity's exit condition.
{OnTheWorkListOf} The persons who have a work item assigned.
{ProcessAdmin} The process administrator.
{Priority} The item's priority.
{InputDataStructure} The name of the template's input data structure.
{OutputDataStructure} The name of the template's output data structure.
{Documentation} The process documentation.
{Received} The item's start time.
{FirstNotification} The item's first notification time.
{SecondNotification} The item's second notification time.
{Finished} The item's end time.
{_ActionArea_} A form containing the Back button.
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. If the work item was started instead of checked out (because the work item could not be checked out and the startAllowed request parameter was set), the work list is shown again. Otherwise, an HTML template will be loaded from 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

checkInWorkItemResponse

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

cancelWorkItemResponse

public ResponsePage cancelWorkItemResponse(RequestContext context)
                                    throws ClientException
Creates the page that is displayed when a work item checkout has been canceled. This page calls BuiltinHandler.queryWorkItems() to show the work list again.
Specified by:
cancelWorkItemResponse 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

forceFinishWorkItemResponse

public ResponsePage forceFinishWorkItemResponse(RequestContext context)
                                         throws ClientException
Creates the page that is displayed when a work item has been force finished. If the work item was actually force finished, this method simply calls the BuiltinHandler.queryWorkItems() method. If the work item was not yet force finished because the necessary data has not yet been specified, it will be force finished first.
Specified by:
forceFinishWorkItemResponse in interface Viewer
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - if an error occurred

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

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

forceRestartWorkItemResponse

public ResponsePage forceRestartWorkItemResponse(RequestContext context)
                                          throws ClientException
Creates the page that is displayed when a work item has been force restarted. If the work item was actually force restarted, this method simply calls the BuiltinHandler.queryWorkItems() method. If the work item was not yet force restarted because the necessary data has not yet been specified, it will be force restarted first.
Specified by:
forceRestartWorkItemResponse 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

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

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

getFilterAssistantResponse

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

Specified by:
getFilterAssistantResponse in interface Viewer

setUserSettingsResponse

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

Specified by:
setUserSettingsResponse in interface Viewer

setViewSettingsResponse

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

Specified by:
setViewSettingsResponse in interface Viewer

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

queryActivityInstancesResponse

public ResponsePage queryActivityInstancesResponse(RequestContext context)
                                            throws ClientException

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


createNavigatorEntries

public java.util.Vector createNavigatorEntries(RequestContext context,
                                               boolean enableLogoff)
                                        throws ClientException
Deprecated. - this function will be redesigned in a later release

Description copied from interface: Viewer
This method is called to initialize the Navigation entries for the list views
Specified by:
createNavigatorEntries in interface Viewer
Following copied from interface: com.ibm.workflow.portlet.client.Viewer
Parameters:
context - The request context.
Returns:
The navigator entries
Throws:
com.ibm.workflow.servlet.client.ClientException - If an error occurred.


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