|
||||||||||
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
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.
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 |
public DefaultViewer()
Method Detail |
public void init(Config config)
[DefaultViewer]
section in the
servlet configuration file.init
in interface Viewer
config
- the servlet configuration.public ResponsePage errorResponse(RequestContext context)
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. |
errorResponse
in interface Viewer
context
- The request context.public ResponsePage logonResponse(RequestContext context) throws ClientException
logonResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage logoffResponse(RequestContext context)
PageAfterLogoff
setting in
the PortalClient.properties
configuration file.logoffResponse
in interface Viewer
context
- The request context.public ResponsePage queryListsResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.queryLists()
command.queryListsResponse
in interface Viewer
context
- The request context.null
.ClientException
- if an error occurredpublic ResponsePage showListPropertiesResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.showListProperties()
command.showListPropertiesResponse
in interface Viewer
context
- The request context.null
.ClientException
- if an error occurredpublic ResponsePage setListPropertiesResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.setListProperties()
command.setListPropertiesResponse
in interface Viewer
com.ibm.workflow.portlet.client.Viewer
context
- The request context.com.ibm.workflow.servlet.client.ClientException
- If an error occurred.public 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 createListResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.createList()
command.createListResponse
in interface Viewer
com.ibm.workflow.portlet.client.Viewer
context
- The request context.com.ibm.workflow.servlet.client.ClientException
- If an error occurred.public ResponsePage createPersistentListResponse(RequestContext context) throws ClientException
Viewer
BuiltinHandler.createPersistentList()
command.createPersistentListResponse
in interface Viewer
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
queryProcessTemplatesResponse
in interface Viewer
context
- The request context.null
if template lists are
disabledClientException
- if an error occurredpublic ResponsePage showTemplatePropertiesResponse(RequestContext context) throws ClientException
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. |
showTemplatePropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage createInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.queryProcessTemplates()
to show the template list again.createInstanceResponse
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, 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 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. |
createAndStartInstanceResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage deleteTemplateResponse(RequestContext context) throws ClientException
BuiltinHandler.queryProcessTemplates()
to show the template list again.deleteTemplateResponse
in interface Viewer
context
- the request contextClientException
- if an error occurredpublic ResponsePage queryProcessInstancesResponse(RequestContext context) throws ClientException
queryProcessInstancesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage showInstancePropertiesResponse(RequestContext context) throws ClientException
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. |
showInstancePropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage startInstanceResponse(RequestContext context) throws ClientException
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. |
startInstanceResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage deleteInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.queryProcessInstances()
to show the instance list again.deleteInstanceResponse
in interface Viewer
context
- the request contextClientException
- if an error occurredpublic ResponsePage suspendInstanceResponse(RequestContext context) throws ClientException
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.suspendInstanceResponse
in interface Viewer
context
- the request contextClientException
- 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 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 restartInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.queryProcessInstances()
restartInstanceResponse
in interface Viewer
context
- the request contextClientException
- if an error occurredpublic ResponsePage showActivityPropertiesResponse(RequestContext context) throws ClientException
JSPPortletViewer
.showActivityPropertiesResponse
in interface Viewer
context
- The request context.null
.ClientException
- if an error occurredpublic ResponsePage forceRestartActivityResponse(RequestContext context) throws ClientException
JSPPortletViewer
.forceRestartActivityResponse
in interface Viewer
context
- The request context.null
.ClientException
- if an error occurredpublic ResponsePage forceFinishActivityResponse(RequestContext context) throws ClientException
JSPPortletViewer
.forceFinishActivityResponse
in interface Viewer
context
- The request context.null
.ClientException
- if an error occurredpublic ResponsePage terminateActivityResponse(RequestContext context) throws ClientException
JSPPortletViewer
.terminateActivityResponse
in interface Viewer
context
- The request context.null
.ClientException
- if an error occurredpublic ResponsePage showControlConnectorPropertiesResponse(RequestContext context) throws ClientException
JSPPortletViewer
.showControlConnectorPropertiesResponse
in interface Viewer
context
- The request context.null
.ClientException
- if an error occurredpublic ResponsePage queryWorkItemsResponse(RequestContext context) throws ClientException
queryWorkItemsResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage showWorkItemPropertiesResponse(RequestContext context) throws ClientException
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. |
showWorkItemPropertiesResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage checkOutWorkItemResponse(RequestContext context) throws ClientException
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 . |
checkOutWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage checkInWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.queryWorkItems()
to show the work list again.checkInWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic ResponsePage cancelWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.queryWorkItems()
to show the work list again.cancelWorkItemResponse
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 forceFinishWorkItemResponse(RequestContext context) throws ClientException
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.forceFinishWorkItemResponse
in interface Viewer
context
- The request context.ClientException
- if an error occurredpublic 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 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 forceRestartWorkItemResponse(RequestContext context) throws ClientException
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.forceRestartWorkItemResponse
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 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 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 ResponsePage getFilterAssistantResponse(RequestContext context) throws ClientException
getFilterAssistantResponse
in interface Viewer
public ResponsePage setUserSettingsResponse(RequestContext context) throws ClientException
setUserSettingsResponse
in interface Viewer
public ResponsePage setViewSettingsResponse(RequestContext context) throws ClientException
setViewSettingsResponse
in interface Viewer
public ResponsePage getUserInfoResponse(RequestContext context) throws ClientException
getUserInfoResponse
in interface Viewer
public ResponsePage getSystemInfoResponse(RequestContext context) throws ClientException
getSystemInfoResponse
in interface Viewer
public ResponsePage queryActivityInstancesResponse(RequestContext context) throws ClientException
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)
public java.util.Vector createNavigatorEntries(RequestContext context, boolean enableLogoff) throws ClientException
Viewer
createNavigatorEntries
in interface Viewer
com.ibm.workflow.portlet.client.Viewer
context
- The request context.com.ibm.workflow.servlet.client.ClientException
- If an error occurred.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |