com.ibm.workflow.servlet.client
Class BuiltinHandler

java.lang.Object
  |
  +--com.ibm.workflow.servlet.client.BuiltinHandler

public final class BuiltinHandler
extends java.lang.Object

This class handles all commands known by the Web Client's servlet itself. Commands can be invoked in the following ways:


Method Summary
 RequestContext cancelWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext cancelWorkItem(RequestContext ctx, java.lang.String oid, java.lang.String owner)
           
 RequestContext checkInWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext checkOutWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext checkOutWorkItem(RequestContext ctx, java.lang.String oid, java.lang.String owner, boolean startAllowed)
           
 RequestContext createAndStartInstance(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Creates and starts a process instance.
 RequestContext createInstance(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext createInstance(RequestContext ctx, java.lang.String instanceName)
           
 RequestContext createList(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. - this function will be redesigned in a later release
 RequestContext createList(RequestContext context)
          Deprecated. - this function will be redesigned in a later release
 RequestContext createPersistentList(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. - this function will be redesigned in a later release
 RequestContext deleteInstance(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext deleteInstance(RequestContext ctx)
           
 RequestContext deleteItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext deleteList(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext deleteList(RequestContext ctx)
           
 RequestContext deleteTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext deleteTemplate(RequestContext ctx)
           
 RequestContext finishWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext finishWorkItem(RequestContext ctx, java.lang.String oid, java.lang.String owner)
           
 RequestContext forceFinishActivity(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext forceFinishWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext forceFinishWorkItem(RequestContext ctx, java.lang.String oid, java.lang.String submit, java.lang.String owner)
           
 RequestContext forceRestartActivity(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext forceRestartWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext forceRestartWorkItem(RequestContext ctx, java.lang.String oid, java.lang.String submit, java.lang.String owner)
           
 RequestContext getFilterAssistant(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. - this function will be redesigned in a later release
 RequestContext getSortCriteriaAssistant(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. - this function will be redesigned in a later release
 RequestContext getSystemInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. - this function will be redesigned in a later release
 RequestContext getUserInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. - this function will be redesigned in a later release
 RequestContext logoff(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Logs off from to the MQSeries Workflow system.
 RequestContext logon(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Logs on to the MQSeries Workflow system.
 RequestContext queryActivityInstanceLists(RequestContext ctx)
           
 RequestContext queryActivityInstances(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Queries the activity instances on the specified activityInstance list.
 RequestContext queryActivityInstances(RequestContext ctx, java.lang.String oid, boolean useCache)
          Queries the activity instances of the specified activity instance list.
 RequestContext queryLists(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext queryLists(RequestContext ctx, boolean useCache)
           
 RequestContext queryProcessInstanceLists(RequestContext ctx)
           
 RequestContext queryProcessInstances(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Queries the process instances on the specified instance list.
 RequestContext queryProcessInstances(RequestContext ctx, java.lang.String oid, boolean useCache)
          Queries the process instances of the specified instance list.
 RequestContext queryProcessTemplateLists(RequestContext ctx)
           
 RequestContext queryProcessTemplates(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Queries the process templates on the specified template list.
 RequestContext queryProcessTemplates(RequestContext ctx, java.lang.String oid, boolean useCache)
          Queries the process templates of the specified template list.
 RequestContext queryWorkItems(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Queries the work items on the specified worklist.
 RequestContext queryWorkItems(RequestContext ctx, java.lang.String oid, boolean useCache)
          Queries the work items of the specified worklist.
 RequestContext queryWorkLists(RequestContext ctx)
           
 ResponsePage render(java.lang.String command, RequestContext ctx)
           
 RequestContext restartInstance(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext restartInstance(RequestContext ctx, java.lang.String oid)
           
 RequestContext restartWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext restartWorkItem(RequestContext ctx, java.lang.String oid, java.lang.String owner)
           
 RequestContext resumeInstance(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext resumeInstance(RequestContext ctx, boolean deep)
           
 RequestContext setListProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext setUserSettings(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. - this function will be redesigned in a later release
 RequestContext setViewSettings(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. - this function will be redesigned in a later release
 RequestContext showActivityProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext showActivityProperties(RequestContext ctx)
           
 RequestContext showControlConnectorProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext showInstanceProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext showInstanceProperties(RequestContext ctx)
           
 RequestContext showListProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext showListProperties(RequestContext ctx)
           
 RequestContext showTemplateProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext showTemplateProperties(RequestContext ctx)
           
 RequestContext showWorkItemProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext showWorkItemProperties(RequestContext ctx, java.lang.String oid, java.lang.String owner)
           
 RequestContext startInstance(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext startWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext startWorkItem(RequestContext ctx, java.lang.String oid, java.lang.String owner)
           
 RequestContext suspendInstance(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Suspends a process instance.
 RequestContext suspendInstance(RequestContext ctx, java.lang.String oid, java.lang.String submit, boolean deep, java.lang.String year, java.lang.String month, java.lang.String day, java.lang.String hour, java.lang.String minute)
          Suspends a process instance.
 RequestContext terminateActivity(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext terminateActivity(RequestContext ctx)
           
 RequestContext terminateInstance(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext terminateInstance(RequestContext ctx)
           
 RequestContext terminateWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext terminateWorkItem(RequestContext ctx, java.lang.String oid, java.lang.String owner)
           
 RequestContext transferItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 RequestContext transferItem(RequestContext result, java.lang.String oid, java.lang.String owner, java.lang.String userID)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

render

public ResponsePage render(java.lang.String command,
                           RequestContext ctx)
                    throws ClientException

logon

public RequestContext logon(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws ClientException
Logs on to the MQSeries Workflow system.
Parameters:
request - The request the client has made of the servlet. The parameters are:
Name Default Description
userID   The user ID to be used for the logon. This cannot be the same ID as used for the Web user feature.
password   The password valid for the specified user ID.
group null The system group to be logged on.
system null The system within the system group to be logged on to. To support clustering, do not use this parameter unless you must.
mode DEFAULT Session mode. Can be 'PRESENT_HERE' or 'PRESENT'. All other values will cause 'DEFAULT' to be used.
absenceIndicator RESET Absence indicator. Can be 'LEAVE'. All other values will cause 'RESET' to be used.
timezoneOffset   If set, specifies the difference between GMT and the client's timezone in minutes (see also the JavaScript Data.getTimezoneOffset() method).
response - The response the servlet sends to the client
Returns:
a RequestContext object with the new session
Throws:
ClientException - If an error occurred.

logoff

public RequestContext logoff(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws ClientException
Logs off from to the MQSeries Workflow system.
Parameters:
request - The request the client has made of the servlet. There are no parameters.
response - The response the servlet sends to the client
Returns:
a RequestContext object with the logged-of session
Throws:
ClientException - If an error occurred.

queryLists

public RequestContext queryLists(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws ClientException

queryLists

public RequestContext queryLists(RequestContext ctx,
                                 boolean useCache)
                          throws ClientException

showListProperties

public RequestContext showListProperties(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
                                  throws ClientException

showListProperties

public RequestContext showListProperties(RequestContext ctx)
                                  throws ClientException

setListProperties

public RequestContext setListProperties(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws ClientException

deleteList

public RequestContext deleteList(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws ClientException

deleteList

public RequestContext deleteList(RequestContext ctx)
                          throws ClientException

createList

public RequestContext createList(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws ClientException
Deprecated. - this function will be redesigned in a later release


createList

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


queryProcessTemplateLists

public RequestContext queryProcessTemplateLists(RequestContext ctx)
                                         throws ClientException

queryActivityInstances

public RequestContext queryActivityInstances(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws ClientException
Queries the activity instances on the specified activityInstance list.
Parameters:
request - The request the client has made of the servlet. The parameters are:
Name Default Description
id   The OID of the activity instance list to refresh.
useCache false If set to true, the activity instances will not be queried but the cached list will be displayed instead.
response - The response the servlet sends to the client
Returns:
See queryActivityInstances(RequestContext, String, boolean).
Throws:
ClientException - If an error occurred.

queryActivityInstances

public RequestContext queryActivityInstances(RequestContext ctx,
                                             java.lang.String oid,
                                             boolean useCache)
                                      throws ClientException
Queries the activity instances of the specified activity instance list.
Parameters:
ctx - the RequestContext object where to store the results
oid - the OID of the template list to be refreshed
useCache - flag indicating if the templates cached in the SessionContext can be used or if the MQSeries Workflow API must be called. If the cache is empty, this parameter will be ignored.
Returns:
The RequestContext object passed as parameter, containing the activity instance list and activity instances.
Throws:
ClientException - If an error occurred.
See Also:
queryProcessTemplates(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

queryProcessTemplates

public RequestContext queryProcessTemplates(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
                                     throws ClientException
Queries the process templates on the specified template list.
Parameters:
request - The request the client has made of the servlet. The parameters are:
Name Default Description
id   The OID of the process template list to refresh.
useCache false If set to true, the templates will not be queried but the cached list will be displayed instead.
response - The response the servlet sends to the client
Returns:
See queryProcessTemplates(RequestContext, String, boolean).
Throws:
ClientException - If an error occurred.

queryProcessTemplates

public RequestContext queryProcessTemplates(RequestContext ctx,
                                            java.lang.String oid,
                                            boolean useCache)
                                     throws ClientException
Queries the process templates of the specified template list.
Parameters:
ctx - the RequestContext object where to store the results
oid - the OID of the template list to be refreshed
useCache - flag indicating if the templates cached in the SessionContext can be used or if the MQSeries Workflow API must be called. If the cache is empty, this parameter will be ignored.
Returns:
The RequestContext object passed as parameter, containing the template list and process templates.
Throws:
ClientException - If an error occurred.
See Also:
queryProcessTemplates(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

showTemplateProperties

public RequestContext showTemplateProperties(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws ClientException

showTemplateProperties

public RequestContext showTemplateProperties(RequestContext ctx)
                                      throws ClientException

createInstance

public RequestContext createInstance(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws ClientException

createInstance

public RequestContext createInstance(RequestContext ctx,
                                     java.lang.String instanceName)
                              throws ClientException

createAndStartInstance

public RequestContext createAndStartInstance(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws ClientException
Creates and starts a process instance. The request may contain either a template OID (id, usually if the process is to be created from a template list) or a template name (templateName, if the process is created by the web user). A process requires input data if:
Parameters:
request - The request the client has made of the servlet. The parameters are:
Name Default Description
id   The OID of the process template to create an instance from.
templateName   The name of the process template to create an instance from. This parameter can only be used for the Web user feature.
instanceName null The desired name for the newly created instance.
SuccessLocation null Used by DefaultViewer, allows to specify the page to be displayed after a process instance was started by the Web user.
UseRedirect false Used by DefaultViewer. If set to true, the request is redirected to the page specified by SuccessLocation. If false, the page specified by SuccessLocation is treated as an HTML template file.
submitData null If set, data from the request will be used to fill the input container.
<any> null Values of request parameters whose names match input container member names are set in the input container before starting the process.
response - The response the servlet sends to the client
Returns:
A RequestContext object containing the process template and the process instance, if one was started.
Throws:
ClientException - If an error occurred.

deleteTemplate

public RequestContext deleteTemplate(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws ClientException

deleteTemplate

public RequestContext deleteTemplate(RequestContext ctx)
                              throws ClientException

queryProcessInstanceLists

public RequestContext queryProcessInstanceLists(RequestContext ctx)
                                         throws ClientException

queryProcessInstances

public RequestContext queryProcessInstances(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
                                     throws ClientException
Queries the process instances on the specified instance list.
Parameters:
request - The request the client has made of the servlet. The parameters are:
Name Default Description
id   The OID of the process instance list to refresh.
useCache false If set to true, the instances will not be queried but the cached list will be displayed instead.
response - The response the servlet sends to the client
Returns:
See queryProcessInstances(RequestContext, String, boolean).
Throws:
ClientException - If an error occurred.

queryProcessInstances

public RequestContext queryProcessInstances(RequestContext ctx,
                                            java.lang.String oid,
                                            boolean useCache)
                                     throws ClientException
Queries the process instances of the specified instance list.
Parameters:
ctx - the RequestContext object where to store the results
oid - the OID of the instance list to be used
useCache - flag indicating if the instances cached in the SessionContext can be used or if the MQSeries Workflow API must be called. If the cache is empty, this parameter will be ignored.
Returns:
The RequestContext object passed as parameter, containing the instance list and process instances.
Throws:
ClientException - If an error occurred.
See Also:
queryProcessInstances(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

showInstanceProperties

public RequestContext showInstanceProperties(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws ClientException

showInstanceProperties

public RequestContext showInstanceProperties(RequestContext ctx)
                                      throws ClientException

deleteInstance

public RequestContext deleteInstance(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws ClientException

deleteInstance

public RequestContext deleteInstance(RequestContext ctx)
                              throws ClientException

startInstance

public RequestContext startInstance(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws ClientException

suspendInstance

public RequestContext suspendInstance(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws ClientException
Suspends a process instance.
Parameters:
request - The request the client has made of the servlet. The parameters are:
Name Default Description
id   The OID of the process instance to suspend.
submitData   If this parameter has a non-null value, the process instance will be suspended. Otherwise, it will just be looked up and stored in the RequestContext object returned.
deep true Whether to include all sub-processes when suspending.
year,month,day,hour,minute   Until when to suspend the process. Either all or none of these parameters must be set. If no date is specified, the process will be suspended indefinitely.
response - The response the servlet sends to the client
Returns:
See suspendInstance(RequestContext, String, String, boolean, String, String, String, String, String).
Throws:
ClientException - If an error occurred.

suspendInstance

public RequestContext suspendInstance(RequestContext ctx,
                                      java.lang.String oid,
                                      java.lang.String submit,
                                      boolean deep,
                                      java.lang.String year,
                                      java.lang.String month,
                                      java.lang.String day,
                                      java.lang.String hour,
                                      java.lang.String minute)
                               throws ClientException
Suspends a process instance.
Parameters:
ctx - the RequestContext object where to store the results
oid - the OID of the process instance to suspend
submit - if null, the process will not be suspended but just looked up and stored in the RequestContext
deep - flag indicating whether to include sub-processes when suspending
year - year until when to suspend the process, may be null
month - month until when to suspend the process, may be null
day - day until when to suspend the process, may be null
hour - hour until when to suspend the process, may be null
minute - minute until when to suspend the process, may be null
Returns:
The RequestContext object passed as parameter, containing the process instance
Throws:
ClientException - If an error occurred.
See Also:
suspendInstance(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

resumeInstance

public RequestContext resumeInstance(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws ClientException

resumeInstance

public RequestContext resumeInstance(RequestContext ctx,
                                     boolean deep)
                              throws ClientException

terminateInstance

public RequestContext terminateInstance(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws ClientException

terminateInstance

public RequestContext terminateInstance(RequestContext ctx)
                                 throws ClientException

restartInstance

public RequestContext restartInstance(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws ClientException

restartInstance

public RequestContext restartInstance(RequestContext ctx,
                                      java.lang.String oid)
                               throws ClientException

showActivityProperties

public RequestContext showActivityProperties(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws ClientException

showActivityProperties

public RequestContext showActivityProperties(RequestContext ctx)
                                      throws ClientException

forceRestartActivity

public RequestContext forceRestartActivity(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
                                    throws ClientException

forceFinishActivity

public RequestContext forceFinishActivity(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response)
                                   throws ClientException

terminateActivity

public RequestContext terminateActivity(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws ClientException

terminateActivity

public RequestContext terminateActivity(RequestContext ctx)
                                 throws ClientException

showControlConnectorProperties

public RequestContext showControlConnectorProperties(javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response)
                                              throws ClientException

queryWorkLists

public RequestContext queryWorkLists(RequestContext ctx)
                              throws ClientException

queryActivityInstanceLists

public RequestContext queryActivityInstanceLists(RequestContext ctx)
                                          throws ClientException

queryWorkItems

public RequestContext queryWorkItems(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws ClientException
Queries the work items on the specified worklist.
Parameters:
request - The request the client has made of the servlet. The parameters are:
Name Default Description
id   The OID of the worklist list to refresh.
useCache false If set to true, the work items will not be queried but the cached list will be displayed instead.
response - The response the servlet sends to the client
Returns:
See queryWorkItems(RequestContext, String, boolean).
Throws:
ClientException - If an error occurred.

queryWorkItems

public RequestContext queryWorkItems(RequestContext ctx,
                                     java.lang.String oid,
                                     boolean useCache)
                              throws ClientException
Queries the work items of the specified worklist.
Parameters:
ctx - the RequestContext object where to store the results
oid - the OID of the worklist to be used
useCache - flag indicating if the work items cached in the SessionContext can be used or if the MQSeries Workflow API must be called. If the cache is empty, this parameter will be ignored.
Returns:
The RequestContext object passed as parameter, containing the work list, work items, process instance notifications, and activity instance notifications.
Throws:
ClientException - If an error occurred.
See Also:
queryWorkItems(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

showWorkItemProperties

public RequestContext showWorkItemProperties(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws ClientException

showWorkItemProperties

public RequestContext showWorkItemProperties(RequestContext ctx,
                                             java.lang.String oid,
                                             java.lang.String owner)
                                      throws ClientException

checkOutWorkItem

public RequestContext checkOutWorkItem(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)
                                throws ClientException

checkOutWorkItem

public RequestContext checkOutWorkItem(RequestContext ctx,
                                       java.lang.String oid,
                                       java.lang.String owner,
                                       boolean startAllowed)
                                throws ClientException

checkInWorkItem

public RequestContext checkInWorkItem(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws ClientException

cancelWorkItem

public RequestContext cancelWorkItem(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws ClientException

cancelWorkItem

public RequestContext cancelWorkItem(RequestContext ctx,
                                     java.lang.String oid,
                                     java.lang.String owner)
                              throws ClientException

finishWorkItem

public RequestContext finishWorkItem(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws ClientException

finishWorkItem

public RequestContext finishWorkItem(RequestContext ctx,
                                     java.lang.String oid,
                                     java.lang.String owner)
                              throws ClientException

forceFinishWorkItem

public RequestContext forceFinishWorkItem(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response)
                                   throws ClientException

forceFinishWorkItem

public RequestContext forceFinishWorkItem(RequestContext ctx,
                                          java.lang.String oid,
                                          java.lang.String submit,
                                          java.lang.String owner)
                                   throws ClientException

restartWorkItem

public RequestContext restartWorkItem(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws ClientException

restartWorkItem

public RequestContext restartWorkItem(RequestContext ctx,
                                      java.lang.String oid,
                                      java.lang.String owner)
                               throws ClientException

forceRestartWorkItem

public RequestContext forceRestartWorkItem(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
                                    throws ClientException

forceRestartWorkItem

public RequestContext forceRestartWorkItem(RequestContext ctx,
                                           java.lang.String oid,
                                           java.lang.String submit,
                                           java.lang.String owner)
                                    throws ClientException

startWorkItem

public RequestContext startWorkItem(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws ClientException

startWorkItem

public RequestContext startWorkItem(RequestContext ctx,
                                    java.lang.String oid,
                                    java.lang.String owner)
                             throws ClientException

terminateWorkItem

public RequestContext terminateWorkItem(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws ClientException

terminateWorkItem

public RequestContext terminateWorkItem(RequestContext ctx,
                                        java.lang.String oid,
                                        java.lang.String owner)
                                 throws ClientException

deleteItem

public RequestContext deleteItem(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws ClientException

transferItem

public RequestContext transferItem(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                            throws ClientException

transferItem

public RequestContext transferItem(RequestContext result,
                                   java.lang.String oid,
                                   java.lang.String owner,
                                   java.lang.String userID)
                            throws ClientException

setUserSettings

public RequestContext setUserSettings(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws ClientException
Deprecated. - this function will be redesigned in a later release


setViewSettings

public RequestContext setViewSettings(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws ClientException
Deprecated. - this function will be redesigned in a later release


getFilterAssistant

public RequestContext getFilterAssistant(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
                                  throws ClientException
Deprecated. - this function will be redesigned in a later release


getSortCriteriaAssistant

public RequestContext getSortCriteriaAssistant(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
                                        throws ClientException
Deprecated. - this function will be redesigned in a later release


getUserInfo

public RequestContext getUserInfo(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws ClientException
Deprecated. - this function will be redesigned in a later release


getSystemInfo

public RequestContext getSystemInfo(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws ClientException
Deprecated. - this function will be redesigned in a later release


createPersistentList

public RequestContext createPersistentList(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
                                    throws ClientException
Deprecated. - this function will be redesigned in a later release



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