com.ibm.workflow.servlet.client
Interface Viewer

All Known Implementing Classes:
JSPViewer, EnhancedJSPViewer, DefaultViewer

public interface Viewer

This class allows you to customize the look and feel of certain parts of the Web Client. This is done by implementing various commandResponse methods that must create response pages for certain client requests (command). If you want to customize only certain elements of the Web Client you should extend the DefaultViewer class in order to inherit the default behaviour for the parts that you do not override.

You must set the DefaultViewer property in the WebClient.properties file to use a viewer other than DefaultViewer.


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)
          This method is called to create the response page for the BuiltinHandler.checkOutWorkItem() command.
 ResponsePage createAndStartInstanceResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.createAndStartInstance() command.
 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.
 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)
          This method is called to create the response page for the BuiltinHandler.deleteItem() command.
 ResponsePage deleteListResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.deleteList() command.
 ResponsePage deleteTemplateResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.deleteTemplate() command.
 ResponsePage errorResponse(RequestContext context)
          This method is called by the Web Client if an error occurred.
 ResponsePage finishWorkItemResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.finishWorkItem() command.
 ResponsePage forceFinishActivityResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.forceFinishActivity() command.
 ResponsePage forceFinishWorkItemResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.forceFinishWorkItem() command.
 ResponsePage forceRestartActivityResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.forceRestartActivity() command.
 ResponsePage forceRestartWorkItemResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.forceRestartWorkItem() command.
 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)
          This method is called after the Web Client's servlet has been initialized.
 ResponsePage logoffResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.logoff() command.
 ResponsePage logonResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.logon() command.
 ResponsePage queryListsResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.queryLists() command.
 ResponsePage queryProcessInstancesResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.queryProcessInstances() command.
 ResponsePage queryProcessTemplatesResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.queryProcessTemplates() command.
 ResponsePage queryWorkItemsResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.queryWorkItems() command.
 ResponsePage restartInstanceResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.restartInstance() command.
 ResponsePage restartWorkItemResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.restartWorkItem() command.
 ResponsePage resumeInstanceResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.resumeInstance() command.
 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 is called to create the response page for the BuiltinHandler.showActivityProperties() command.
 ResponsePage showControlConnectorPropertiesResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.showControlConnectorProperties() command.
 ResponsePage showInstancePropertiesResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.showInstanceProperties() command.
 ResponsePage showListPropertiesResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.showListProperties() command.
 ResponsePage showTemplatePropertiesResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.showTemplateProperties() command.
 ResponsePage showWorkItemPropertiesResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.showWorkItemProperties() command.
 ResponsePage startInstanceResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.startInstance() command.
 ResponsePage startWorkItemResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.startWorkItem() command.
 ResponsePage suspendInstanceResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.suspendInstance() command.
 ResponsePage terminateActivityResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.terminateActivity() command.
 ResponsePage terminateInstanceResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.terminateInstance() command.
 ResponsePage terminateWorkItemResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.terminateWorkItem() command.
 ResponsePage transferItemResponse(RequestContext context)
          This method is called to create the response page for the BuiltinHandler.transferItem() command.
 

Method Detail

init

public void init(Config config)
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.
Parameters:
config - The servlet's configuration and initialization parameters

errorResponse

public ResponsePage errorResponse(RequestContext context)
This method is called by the Web Client if an error occurred. The error can be accessed by using the context.getException() method.
Parameters:
context - The request context.
Returns:
The response page.

logonResponse

public ResponsePage logonResponse(RequestContext context)
                           throws ClientException
This method is called to create the response page for the BuiltinHandler.logon() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

logoffResponse

public ResponsePage logoffResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.logoff() command. This method is called by the Web Client after the user has logged off.
Parameters:
context - The request context.
Returns:
The response page.

queryListsResponse

public ResponsePage queryListsResponse(RequestContext context)
                                throws ClientException
This method is called to create the response page for the BuiltinHandler.queryLists() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

showListPropertiesResponse

public ResponsePage showListPropertiesResponse(RequestContext context)
                                        throws ClientException
This method is called to create the response page for the BuiltinHandler.showListProperties() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

setListPropertiesResponse

public ResponsePage setListPropertiesResponse(RequestContext context)
                                       throws ClientException
This method is called to create the response page for the BuiltinHandler.setListProperties() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

createListResponse

public ResponsePage createListResponse(RequestContext context)
                                throws ClientException
This method is called to create the response page for the BuiltinHandler.createList() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

createPersistentListResponse

public ResponsePage createPersistentListResponse(RequestContext context)
                                          throws ClientException
This method is called to create the response page for the BuiltinHandler.createPersistentList() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

deleteListResponse

public ResponsePage deleteListResponse(RequestContext context)
                                throws ClientException
This method is called to create the response page for the BuiltinHandler.deleteList() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

queryProcessTemplatesResponse

public ResponsePage queryProcessTemplatesResponse(RequestContext context)
                                           throws ClientException
This method is called to create the response page for the BuiltinHandler.queryProcessTemplates() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

showTemplatePropertiesResponse

public ResponsePage showTemplatePropertiesResponse(RequestContext context)
                                            throws ClientException
This method is called to create the response page for the BuiltinHandler.showTemplateProperties() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

createInstanceResponse

public ResponsePage createInstanceResponse(RequestContext context)
                                    throws ClientException
This method is called to create the response page for the BuiltinHandler.createInstance() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

createAndStartInstanceResponse

public ResponsePage createAndStartInstanceResponse(RequestContext context)
                                            throws ClientException
This method is called to create the response page for the BuiltinHandler.createAndStartInstance() command. If the request parameter (see RequestContext.getRequestParameter) id is set, then the process instance has been created from a process template list. If the request parameter templateName is set, then the process instance has been started from the web user.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

deleteTemplateResponse

public ResponsePage deleteTemplateResponse(RequestContext context)
                                    throws ClientException
This method is called to create the response page for the BuiltinHandler.deleteTemplate() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

queryProcessInstancesResponse

public ResponsePage queryProcessInstancesResponse(RequestContext context)
                                           throws ClientException
This method is called to create the response page for the BuiltinHandler.queryProcessInstances() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

showInstancePropertiesResponse

public ResponsePage showInstancePropertiesResponse(RequestContext context)
                                            throws ClientException
This method is called to create the response page for the BuiltinHandler.showInstanceProperties() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

deleteInstanceResponse

public ResponsePage deleteInstanceResponse(RequestContext context)
                                    throws ClientException
This method is called to create the response page for the BuiltinHandler.deleteInstance() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

startInstanceResponse

public ResponsePage startInstanceResponse(RequestContext context)
                                   throws ClientException
This method is called to create the response page for the BuiltinHandler.startInstance() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

suspendInstanceResponse

public ResponsePage suspendInstanceResponse(RequestContext context)
                                     throws ClientException
This method is called to create the response page for the BuiltinHandler.suspendInstance() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

resumeInstanceResponse

public ResponsePage resumeInstanceResponse(RequestContext context)
                                    throws ClientException
This method is called to create the response page for the BuiltinHandler.resumeInstance() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

terminateInstanceResponse

public ResponsePage terminateInstanceResponse(RequestContext context)
                                       throws ClientException
This method is called to create the response page for the BuiltinHandler.terminateInstance() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

restartInstanceResponse

public ResponsePage restartInstanceResponse(RequestContext context)
                                     throws ClientException
This method is called to create the response page for the BuiltinHandler.restartInstance() command.
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 is called to create the response page for the BuiltinHandler.showActivityProperties() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

forceRestartActivityResponse

public ResponsePage forceRestartActivityResponse(RequestContext context)
                                          throws ClientException
This method is called to create the response page for the BuiltinHandler.forceRestartActivity() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

forceFinishActivityResponse

public ResponsePage forceFinishActivityResponse(RequestContext context)
                                         throws ClientException
This method is called to create the response page for the BuiltinHandler.forceFinishActivity() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

terminateActivityResponse

public ResponsePage terminateActivityResponse(RequestContext context)
                                       throws ClientException
This method is called to create the response page for the BuiltinHandler.terminateActivity() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

showControlConnectorPropertiesResponse

public ResponsePage showControlConnectorPropertiesResponse(RequestContext context)
                                                    throws ClientException
This method is called to create the response page for the BuiltinHandler.showControlConnectorProperties() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

queryWorkItemsResponse

public ResponsePage queryWorkItemsResponse(RequestContext context)
                                    throws ClientException
This method is called to create the response page for the BuiltinHandler.queryWorkItems() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

showWorkItemPropertiesResponse

public ResponsePage showWorkItemPropertiesResponse(RequestContext context)
                                            throws ClientException
This method is called to create the response page for the BuiltinHandler.showWorkItemProperties() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

checkOutWorkItemResponse

public ResponsePage checkOutWorkItemResponse(RequestContext context)
                                      throws ClientException
This method is called to create the response page for the BuiltinHandler.checkOutWorkItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

checkInWorkItemResponse

public ResponsePage checkInWorkItemResponse(RequestContext context)
                                     throws ClientException
This method is called to create the response page for the BuiltinHandler.checkInWorkItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

cancelWorkItemResponse

public ResponsePage cancelWorkItemResponse(RequestContext context)
                                    throws ClientException
This method is called to create the response page for the BuiltinHandler.cancelWorkItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

finishWorkItemResponse

public ResponsePage finishWorkItemResponse(RequestContext context)
                                    throws ClientException
This method is called to create the response page for the BuiltinHandler.finishWorkItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

forceFinishWorkItemResponse

public ResponsePage forceFinishWorkItemResponse(RequestContext context)
                                         throws ClientException
This method is called to create the response page for the BuiltinHandler.forceFinishWorkItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

startWorkItemResponse

public ResponsePage startWorkItemResponse(RequestContext context)
                                   throws ClientException
This method is called to create the response page for the BuiltinHandler.startWorkItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

restartWorkItemResponse

public ResponsePage restartWorkItemResponse(RequestContext context)
                                     throws ClientException
This method is called to create the response page for the BuiltinHandler.restartWorkItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

forceRestartWorkItemResponse

public ResponsePage forceRestartWorkItemResponse(RequestContext context)
                                          throws ClientException
This method is called to create the response page for the BuiltinHandler.forceRestartWorkItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

terminateWorkItemResponse

public ResponsePage terminateWorkItemResponse(RequestContext context)
                                       throws ClientException
This method is called to create the response page for the BuiltinHandler.terminateWorkItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

deleteItemResponse

public ResponsePage deleteItemResponse(RequestContext context)
                                throws ClientException
This method is called to create the response page for the BuiltinHandler.deleteItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

transferItemResponse

public ResponsePage transferItemResponse(RequestContext context)
                                  throws ClientException
This method is called to create the response page for the BuiltinHandler.transferItem() command.
Parameters:
context - The request context.
Returns:
The response page.
Throws:
ClientException - If an error occurred.

setUserSettingsResponse

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


setViewSettingsResponse

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


getFilterAssistantResponse

public ResponsePage getFilterAssistantResponse(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


getSystemInfoResponse

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



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