|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.workflow.portlet.client.DefaultViewer | +--com.ibm.workflow.portlet.client.JSPViewer
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.
A lot of control flow logic is inherited from the base class
DefaultViewer
, here only those methods that actually invoke
JSPs are overridden.
You must set
DefaultViewer=com.ibm.worklflow.servlet.client.JSPViewer
in the
PortalClient.properties
file to in order to enable this Viewer
.
Constructor Summary | |
---|---|
JSPViewer()
|
Method Summary | |
---|---|
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 |
createListResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.createList() command. |
ResponsePage |
errorResponse(RequestContext context)
Creates the page that is shown in case of an error. |
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. |
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 |
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 |
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 |
setListPropertiesResponse(RequestContext context)
Creates the page that displays the list of lists. |
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 |
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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public JSPViewer()
Method Detail |
public ResponsePage errorResponse(RequestContext context)
NoSessionException
are
passed on to the base class. In the case of an expired session, the
original command will be remembered and executed after a successful
re-logon.errorResponse
in class DefaultViewer
context
- The request context.public ResponsePage logonResponse(RequestContext context) throws ClientException
errorResponse(com.ibm.workflow.portlet.client.RequestContext)
), the
remembered command is extracted and executed. Otherwise, the base
class is called to display the first list. If no list is found, the
page to create a new list will be returned.logonResponse
in class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage logoffResponse(RequestContext context)
Logon.jsp
.logoffResponse
in class DefaultViewer
context
- The request context.public ResponsePage queryListsResponse(RequestContext context) throws ClientException
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.queryListsResponse
in class DefaultViewer
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 class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage setListPropertiesResponse(RequestContext context) throws ClientException
forms/ListViewer.jsp
which dynamically creates a page that contains a table with a row
for each list.setListPropertiesResponse
in class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage createListResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.createList()
command.createListResponse
in class DefaultViewer
com.ibm.workflow.portlet.client.Viewer
context
- The request context.com.ibm.workflow.servlet.client.ClientException
- If an error occurred.public ResponsePage queryProcessTemplatesResponse(RequestContext context) throws ClientException
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.queryProcessTemplatesResponse
in class DefaultViewer
context
- The request context.null
if template lists are
disabledClientException
- if an error occurredpublic ResponsePage showTemplatePropertiesResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
.showTemplatePropertiesResponse
in class DefaultViewer
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
request will be passed to the base class DefaultViewer
.
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.
If the process instance was started by the web user, and the
SuccessLocation
request parameter is not set or does not point
to a JSP, the request will be passed to the base class DefaultViewer
.
createAndStartInstanceResponse
in class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage queryProcessInstancesResponse(RequestContext context) throws ClientException
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.queryProcessInstancesResponse
in class DefaultViewer
context
- The request context.null
if template lists are
disabledClientException
- if an error occurredpublic ResponsePage showInstancePropertiesResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
.showInstancePropertiesResponse
in class DefaultViewer
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 class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage suspendInstanceResponse(RequestContext context) throws ClientException
suspendInstanceResponse
method will be called. 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.suspendInstanceResponse
in class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage showActivityPropertiesResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
.showActivityPropertiesResponse
in class DefaultViewer
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 class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage forceFinishActivityResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
(this
is the only page from where activities can be force finished). 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 class DefaultViewer
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 class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage showControlConnectorPropertiesResponse(RequestContext context) throws ClientException
forms/PropertiesViewer.jsp
.showControlConnectorPropertiesResponse
in class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage queryWorkItemsResponse(RequestContext context) throws ClientException
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.queryWorkItemsResponse
in class DefaultViewer
context
- The request context.null
if template lists are
disabledClientException
- if an error occurredpublic ResponsePage showWorkItemPropertiesResponse(RequestContext context) throws ClientException
jsp/PropertiesViewer.jsp
.showWorkItemPropertiesResponse
in class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage checkOutWorkItemResponse(RequestContext context) throws ClientException
This request will be forwarded to
programs/ProgramName.html
(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 be passed to the base class DefaultViewer
.
checkOutWorkItemResponse
in class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage forceFinishWorkItemResponse(RequestContext context) throws ClientException
forceFinishWorkItemResponse
method. If it has not yet been force finished because the necessary data
has not been specified, the request will be forwarded to
jsp/ForceFinish.jsp
so the parameters for the
forceFinishWorkItem
command
can be specified.forceFinishWorkItemResponse
in class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage forceRestartWorkItemResponse(RequestContext context) throws ClientException
forceRestartWorkItemResponse
method. If it has not yet been force restarted because the necessary data
has not been specified, the request will be forwarded to
jsp/ForceRestart.jsp
so the parameters for the
forceRestartWorkItem
command
can be specified.forceRestartWorkItemResponse
in class DefaultViewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage getFilterAssistantResponse(RequestContext context) throws ClientException
getFilterAssistantResponse
in class DefaultViewer
public ResponsePage getSortCriteriaAssistantResponse(RequestContext context) throws ClientException
public ResponsePage getUserInfoResponse(RequestContext context) throws ClientException
getUserInfoResponse
in class DefaultViewer
public ResponsePage getSystemInfoResponse(RequestContext context) throws ClientException
getSystemInfoResponse
in class DefaultViewer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |