|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.workflow.servlet.client.EnhancedJSPViewer
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 | |
---|---|
EnhancedJSPViewer()
|
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 |
public EnhancedJSPViewer()
Method Detail |
public void init(Config config)
Viewer
DefaultViewer.java
.init
in interface Viewer
com.ibm.workflow.servlet.client.Viewer
config
- The servlet's configuration and initialization parameterspublic ResponsePage errorResponse(RequestContext context)
errorResponse
in interface Viewer
context
- The request context.public ResponsePage logonResponse(RequestContext context) throws ClientException
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.logonResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage logoffResponse(RequestContext context)
Logon.jsp
.logoffResponse
in interface Viewer
context
- The request context.public ResponsePage queryActivityInstancesResponse(RequestContext context) throws ClientException
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 entriescontext
- The request context.null
if activity lists are
disabled and the Command sent is not 'createPersistentList'. If
process instance lists are disabled and the Command is 'createPersistentList'
the list of lists will be displayed.ClientException
- if an error occurredpublic ResponsePage queryListsResponse(RequestContext context) throws ClientException
forms/ListofLists.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.queryListsResponse
in interface Viewer
context
- The request context.null
if lists of lists are
disabledClientException
- if an error occurredpublic ResponsePage showListPropertiesResponse(RequestContext context) throws ClientException
forms/ListPropertiesViewer.jsp
.showListPropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage setListPropertiesResponse(RequestContext context) throws ClientException
forms/ListofLists.jsp
which dynamically creates a page that contains a table with a row
for each list.setListPropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage createListResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.createList()
command.createListResponse
in interface Viewer
com.ibm.workflow.servlet.client.Viewer
context
- The request context.ClientException
- If an error occurred.public ResponsePage queryProcessTemplatesResponse(RequestContext context) throws ClientException
forms/ProcessTemplateList.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.queryProcessTemplatesResponse
in interface Viewer
context
- The request context.null
if template lists are
disabled and the Command sent is not 'createPersistentList'. If
process instance lists are disabled and the Command is 'createPersistentList'
the list of lists will be displayed.ClientException
- if an error occurredpublic ResponsePage showTemplatePropertiesResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
.showTemplatePropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage createAndStartInstanceResponse(RequestContext context) throws ClientException
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 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.
createAndStartInstanceResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage queryProcessInstancesResponse(RequestContext context) throws ClientException
forms/ProcessInstanceList.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.queryProcessInstancesResponse
in interface Viewer
context
- The request context.null
if instance lists are
disabled and the Command sent is not 'createPersistentList'. If
process instance lists are disabled and the Command is 'createPersistentList'
the list of lists will be displayed.ClientException
- if an error occurredpublic ResponsePage showInstancePropertiesResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
.showInstancePropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage startInstanceResponse(RequestContext context) throws ClientException
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.startInstanceResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage suspendInstanceResponse(RequestContext context) throws ClientException
forms/SuspendInstance.jsp
so the parameters for the
suspendInstance
command can be
specified.suspendInstanceResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage showActivityPropertiesResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
.showActivityPropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage forceRestartActivityResponse(RequestContext context) throws ClientException
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.forceRestartActivityResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage forceFinishActivityResponse(RequestContext context) throws ClientException
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.forceFinishActivityResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage terminateActivityResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
(this is the only page from where
activities can be terminated).terminateActivityResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage showControlConnectorPropertiesResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
.showControlConnectorPropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage queryWorkItemsResponse(RequestContext context) throws ClientException
forms/WorkitemList.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.queryWorkItemsResponse
in interface Viewer
context
- The request context.null
if workitem lists are
disabled and the Command sent is not 'createPersistentList'. If
process instance lists are disabled and the Command is 'createPersistentList'
the list of lists will be displayed.ClientException
- if an error occurredpublic ResponsePage showWorkItemPropertiesResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
.showWorkItemPropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage checkOutWorkItemResponse(RequestContext context) throws ClientException
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 . |
checkOutWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage forceFinishWorkItemResponse(RequestContext context) throws ClientException
forms/ForceFinish.jsp
so the parameters for the
forceFinishWorkItem
command
can be specified.forceFinishWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage forceRestartWorkItemResponse(RequestContext context) throws ClientException
forms/ForceRestart.jsp
so the parameters for the
forceRestartWorkItem
command
can be specified.forceRestartWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage getFilterAssistantResponse(RequestContext context) throws ClientException
getFilterAssistantResponse
in interface Viewer
public ResponsePage getSortCriteriaAssistantResponse(RequestContext context) throws ClientException
public ResponsePage getUserInfoResponse(RequestContext context) throws ClientException
getUserInfoResponse
in interface Viewer
public ResponsePage getSystemInfoResponse(RequestContext context) throws ClientException
getSystemInfoResponse
in interface Viewer
public java.util.Vector createNavigatorEntries(RequestContext context, boolean enableLogoff) throws ClientException
public ResponsePage setUserSettingsResponse(RequestContext context) throws ClientException
setUserSettingsResponse
in interface Viewer
public ResponsePage deleteTemplateResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.deleteTemplate()
command.deleteTemplateResponse
in interface Viewer
com.ibm.workflow.servlet.client.Viewer
context
- The request context.ClientException
- If an error occurred.public ResponsePage cancelWorkItemResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.cancelWorkItem()
command.cancelWorkItemResponse
in interface Viewer
com.ibm.workflow.servlet.client.Viewer
context
- The request context.ClientException
- If an error occurred.public ResponsePage checkInWorkItemResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.checkInWorkItem()
command.checkInWorkItemResponse
in interface Viewer
com.ibm.workflow.servlet.client.Viewer
context
- The request context.ClientException
- If an error occurred.public ResponsePage createInstanceResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.createInstance()
command.createInstanceResponse
in interface Viewer
com.ibm.workflow.servlet.client.Viewer
context
- The request context.ClientException
- If an error occurred.public ResponsePage createPersistentListResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.createPersistentList()
command.createPersistentListResponse
in interface Viewer
com.ibm.workflow.servlet.client.Viewer
context
- The request context.ClientException
- If an error occurred.public ResponsePage deleteInstanceResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.deleteInstance()
command.deleteInstanceResponse
in interface Viewer
com.ibm.workflow.servlet.client.Viewer
context
- The request context.ClientException
- If an error occurred.public ResponsePage deleteItemResponse(RequestContext context) throws ClientException
BuiltinHandler.queryWorkItems()
to show the work list again.deleteItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage deleteListResponse(RequestContext context) throws ClientException
BuiltinHandler.queryLists()
to show the list of lists again.deleteListResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage finishWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.queryWorkItems()
to show the work list again.finishWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage restartInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.queryProcessInstances()
restartInstanceResponse
in interface Viewer
context
- the request contextClientException
- if an error occurredpublic ResponsePage restartWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.queryWorkItems()
to show the work list again.restartWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage resumeInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.queryProcessInstances()
to show the instance list again.resumeInstanceResponse
in interface Viewer
context
- the request contextClientException
- if an error occurredpublic ResponsePage setViewSettingsResponse(RequestContext context) throws ClientException
setViewSettingsResponse
in interface Viewer
public ResponsePage startWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.queryWorkItems()
to show the work list again.startWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage terminateWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.queryWorkItems()
to show the work list again.terminateWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage terminateInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.queryProcessInstances()
to show the instance list again.terminateInstanceResponse
in interface Viewer
context
- the request contextClientException
- if an error occurredpublic ResponsePage transferItemResponse(RequestContext context) throws ClientException
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. |
transferItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic 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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |