A B C D E F G H I J L M N O P Q R S T V W

A

addInstanceList(ProcessInstanceList) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
addTemplateList(ProcessTemplateList) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
addWorkList(WorkList) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
AI_FORCE_FINISH - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ActivityInstance#forceFinish
AI_FORCE_RESTART - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ActivityInstance#forceRestart
AI_SHOW_PROPERTIES - Static variable in class com.ibm.workflow.servlet.client.Command
Command to show activity properties
AI_TERMINATE - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ActivityInstance.terminate()
ApplicationContext - interface com.ibm.workflow.servlet.client.ApplicationContext.
 
AuditTrailHandler - class com.ibm.workflow.servlet.sample.AuditTrailHandler.
This CommandHandler accesses the MQSeries Workflow audit trail using JDBC and returns the event data in XML format.
AuditTrailHandler() - Constructor for class com.ibm.workflow.servlet.sample.AuditTrailHandler
 

B

BasicAuthenticationHandler - class com.ibm.workflow.servlet.sample.BasicAuthenticationHandler.
This CommandHandler extracts the HTTP/1.1 Authentication header from a request and uses it to logon on to MQSeries Workflow, if present.
BasicAuthenticationHandler() - Constructor for class com.ibm.workflow.servlet.sample.BasicAuthenticationHandler
 
BuiltinHandler - class com.ibm.workflow.servlet.client.BuiltinHandler.
This class handles all commands known by the Web Client's servlet itself.

C

cancelWorkItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
cancelWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when a work item checkout has been canceled.
cancelWorkItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.cancelWorkItem() command.
Catalog - interface com.ibm.workflow.servlet.client.Catalog.
This class defines the interface to message catalogs.
checkInWorkItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
checkInWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when a work item has been checked in.
checkInWorkItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.checkInWorkItem() command.
checkOutWorkItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
checkOutWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that will be displayed when a work item has been checked out.
checkOutWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that will be displayed when a work item has been checked out.
checkOutWorkItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.checkOutWorkItem() command.
ClientException - exception com.ibm.workflow.servlet.client.ClientException.
This is the base class for all exceptions thrown within the Web Client framework.
ClientException(HttpServletRequest, String) - Constructor for class com.ibm.workflow.servlet.client.ClientException
Constructs an exception object.
ClientException(HttpServletRequest, Throwable) - Constructor for class com.ibm.workflow.servlet.client.ClientException
Constructs an exception object.
ClientException(HttpServletRequest, Throwable, String) - Constructor for class com.ibm.workflow.servlet.client.ClientException
Constructs an exception object.
ClientException(RequestContext, String) - Constructor for class com.ibm.workflow.servlet.client.ClientException
Constructs an exception object.
ClientException(RequestContext, Throwable) - Constructor for class com.ibm.workflow.servlet.client.ClientException
Constructs an exception object.
ClientException(RequestContext, Throwable, String) - Constructor for class com.ibm.workflow.servlet.client.ClientException
Constructs an exception object.
Command - class com.ibm.workflow.servlet.client.Command.
This class encapsulates what commands are allowed in the various states of process templates, process instances, activity instances, persistent lists, and work items.
Command(String, String, String) - Constructor for class com.ibm.workflow.servlet.client.Command
Constructs a Command object.
Command(String, String, String, String, String) - Constructor for class com.ibm.workflow.servlet.client.Command
Constructs a Command object.
CommandHandler - interface com.ibm.workflow.servlet.client.CommandHandler.
This class allows you to add new commands to the Web Client's servlet and also to extend the servlet's commands.
CommandHandlerAdapter - class com.ibm.workflow.servlet.sample.CommandHandlerAdapter.
CommandHandlerAdapter acts as a CommandHandler which aggregates other CommandHandlers.
CommandHandlerAdapter() - Constructor for class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
 
Config - class com.ibm.workflow.servlet.client.Config.
This class provides access to the settings in the servlet configuration file.
createAndStartInstance(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Creates and starts a process instance.
createAndStartInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page displayed after a new process instance has been created and started.
createAndStartInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page displayed after a new process instance has been created and started.
createAndStartInstanceResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.createAndStartInstance() command.
createInstance(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
createInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page displayed after a new process instance has been created.
createInstanceResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.createInstance() command.
createList(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Deprecated. - this function will be redesigned in a later release
createListResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
 
createListResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
 
createListResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.createList() command.
createNavigatorEntries(RequestContext, boolean) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Deprecated. - this function will be redesigned in a later release
createPersistentList(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Deprecated. - this function will be redesigned in a later release
createPersistentListResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
 
createPersistentListResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.createPersistentList() command.

D

DefaultViewer - class com.ibm.workflow.servlet.client.DefaultViewer.
This class provides the default implementation of the Viewer interface.
DefaultViewer() - Constructor for class com.ibm.workflow.servlet.client.DefaultViewer
 
deleteInstance(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
deleteInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page displayed after a process instance has been deleted.
deleteInstanceResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.deleteInstance() command.
deleteItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
deleteItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when an item has been deleted.
deleteItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.deleteItem() command.
deleteList(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
deleteListResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when a list has been deleted.
deleteListResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.deleteList() command.
deleteTemplate(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
deleteTemplateResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page displayed after a process template has been deleted.
deleteTemplateResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.deleteTemplate() command.
destroy() - Method in interface com.ibm.workflow.servlet.client.CommandHandler
This method is called by the Web Client in its servlet's destroy() method.
destroy() - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
This convenience method has an empty implementation.
destroy() - Method in class com.ibm.workflow.servlet.client.Main
Cleans up the Workflow sessions that are still active, then dispatches the call to the user-defined CommandHandler, if any, to give it the opportunity to clean up resources.
destroy() - Method in class com.ibm.workflow.servlet.sample.AuditTrailHandler
When the handler is unloaded, the cached JDBC connection is closed.
destroy() - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
This method is called by the Web Client in its servlet's destroy() method.

E

EmailHandler - class com.ibm.workflow.servlet.sample.EmailHandler.
A custom handler which will send a notification email to the receiver of a transferred item.
EmailHandler() - Constructor for class com.ibm.workflow.servlet.sample.EmailHandler
 
errorResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is shown in case of an error.
errorResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that is shown in case of an error.
errorResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called by the Web Client if an error occurred.
execute(String, HttpServletRequest, HttpServletResponse) - Method in interface com.ibm.workflow.servlet.client.CommandHandler
This method is called every time a custom command is to be executed.
execute(String, HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
This method is called by the BuiltinHandler to invoke user-defined commands.
execute(String, HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
This method is called every time a custom command is to be executed.

F

finishWorkItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
finishWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when a work item has been finished.
finishWorkItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.finishWorkItem() command.
forceFinishActivity(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
forceFinishActivityResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
This method has an empty implementation since activity actions can only be accessed from activity properties page which requires JSPViewer.
forceFinishActivityResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that is displayed after an activity instance has been force finished.
forceFinishActivityResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.forceFinishActivity() command.
forceFinishWorkItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
forceFinishWorkItem(RequestContext, String, String, String) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
forceFinishWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when a work item has been force finished.
forceFinishWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that is displayed after a work item has been force finished.
forceFinishWorkItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.forceFinishWorkItem() command.
forceRestartActivity(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
forceRestartActivityResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
This method has an empty implementation since activity actions can only be accessed from activity properties page which requires JSPViewer.
forceRestartActivityResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that is displayed after an activity instance has been force restarted.
forceRestartActivityResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.forceRestartActivity() command.
forceRestartWorkItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
forceRestartWorkItem(RequestContext, String, String, String) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
forceRestartWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when a work item has been force restarted.
forceRestartWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that is displayed after a work item has been force restarted.
forceRestartWorkItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.forceRestartWorkItem() command.
format(String) - Static method in class com.ibm.workflow.servlet.sample.AuditTrailHandler
This static method transforms the numeric representation of an MQWF event code to a human-readable string by looking up the translation in the 'AuditTrail.properties' file (which allows for easy language translation).
formatDate(Date) - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 
formatStringArray(String[], String) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
formatTime(Date) - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 

G

generateForm(Command, String, Command, String, Container, Container, String, String) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
GenericCommandHandler - class com.ibm.workflow.servlet.client.GenericCommandHandler.
This class provides a generic implementation of CommandHandler's execute() method which maps the command name directly to the name of the method to be invoked and allows easy access to the ApplicationContext.
GenericCommandHandler() - Constructor for class com.ibm.workflow.servlet.client.GenericCommandHandler
 
get(String) - Method in interface com.ibm.workflow.servlet.client.Catalog
Query a message without substitution variables.
get(String, String) - Method in interface com.ibm.workflow.servlet.client.Catalog
Query a message with one substitution variable.
get(String, String[]) - Method in interface com.ibm.workflow.servlet.client.Catalog
Query a message with multiple substitution variables.
getActionButton(RequestContext, String) - Method in class com.ibm.workflow.servlet.client.Command
Creates an img tag pointing to the action button for this command (<documentRoot>/images/navigation/<commandPicture>).
getActionIcon(RequestContext, String) - Method in class com.ibm.workflow.servlet.client.Command
Creates an img tag pointing to the action icon for this command (<documentRoot>/images/action/<commandPicture>).
getActions(ActivityInstance) - Static method in class com.ibm.workflow.servlet.client.Command
Get the list of allowed commands for an activity instance.
getActions(ActivityInstanceNotification) - Static method in class com.ibm.workflow.servlet.client.Command
Get the list of allowed commands for a activity notification item.
getActions(PersistentList) - Static method in class com.ibm.workflow.servlet.client.Command
Get the list of allowed commands for a persistent list.
getActions(ProcessInstance) - Static method in class com.ibm.workflow.servlet.client.Command
Get the list of allowed commands for a process instance.
getActions(ProcessInstanceNotification) - Static method in class com.ibm.workflow.servlet.client.Command
Get the list of allowed commands for a process notification item.
getActions(ProcessTemplate) - Static method in class com.ibm.workflow.servlet.client.Command
Get the list of allowed commands for a process template.
getActions(String, WorkItem) - Static method in class com.ibm.workflow.servlet.client.Command
Get the list of allowed commands for a work item.
getActivityInstance() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getActivityInstance(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getActivityInstanceNotification(String, String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getActivityInstanceNotifications() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getActivityInstanceNotifications(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getActivityStatistics(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.sample.AuditTrailHandler
This custom command first retrieves the audit records for all activity instances whose names match the name of work item whose OID is passed via the 'id' parameter of the HTTP-request.
getAIImageForState(ExecutionState) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
getAIStringForState(ExecutionState) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getAttribute(String) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getBuiltinHandler() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
This method allows to access the builtin command handler.
getCatalog(String) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getCIStringForState(EvaluationState) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getCommand() - Method in class com.ibm.workflow.servlet.client.Command
Query the command string.
getCommand(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
Constructs a request URI for the Web Client's servlet using the given command.
getCommand(String, String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
Constructs a request URI for the Web Client's servlet using the given command and OID.
getCommand(String, String, String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
Constructs a request URI for the Web Client's servlet using the given command and OID.
getConfig() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
This method allows to access the Web Client's configuration.
getConfig() - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
This method allows subclasses to access the Web Client's configuration.
getContainer() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getContainerData(StringBuffer, String, String, ContainerElement[], Container) - Static method in class com.ibm.workflow.servlet.client.DefaultViewer
Deprecated. - this function will be redesigned in a later release
getContext() - Method in class com.ibm.workflow.servlet.client.Config
Query the application context.
getContext() - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
This method allows subclasses to access the Web Client's context.
getControlConnectorInstance() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getControlConnectorInstance(String, String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getCredentials(HttpServletRequest) - Method in interface com.ibm.workflow.servlet.client.CommandHandler
This method is called by the BuiltinHandler as a pre-logon hook to enable third party authentication.
getCredentials(HttpServletRequest) - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
This method returns null so the normal logon processing takes place.
getCredentials(HttpServletRequest) - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
This method is called by the BuiltinHandler as a pre-logon hook to enable third party authentication.
getCredentials(HttpServletRequest) - Method in class com.ibm.workflow.servlet.sample.BasicAuthenticationHandler
Checks if the request contains HTTP/1.1 Basic Authentication credentials.
getDocBase() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
Deprecated. Use getDocumentRoot instead.
getDocumentRoot() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
Query the Web Client's document root directory.
getException() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getExecutionService() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getFilename() - Method in class com.ibm.workflow.servlet.client.Config
Query the name of the configuration file.
getFilterAssistant(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Deprecated. - this function will be redesigned in a later release
getFilterAssistantResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Deprecated. - this function will be redesigned in a later release
getFilterAssistantResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Deprecated. - this function will be redesigned in a later release
getFilterAssistantResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
Deprecated. - this function will be redesigned in a later release
getHandlerInfo() - Method in interface com.ibm.workflow.servlet.client.CommandHandler
Returns a String that contains information about the handler such as its author, version, and copyright information.
getHandlerInfo() - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
Returns a String that contains information about the handler such as its author, version, and copyright information.
getHandlerInfo() - Method in class com.ibm.workflow.servlet.sample.AuditTrailHandler
Returns information about the handler, such as author, version, and copyright.
getHandlerInfo() - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
Returns information about the handler, such as author, version, and copyright.
getHandlerInfo() - Method in class com.ibm.workflow.servlet.sample.BasicAuthenticationHandler
Returns information about the handler, such as author, version, and copyright.
getHandlerInfo() - Method in class com.ibm.workflow.servlet.sample.EmailHandler
Returns information about the handler, such as author, version, and copyright.
getHandlerInfo() - Method in class com.ibm.workflow.servlet.sample.HTMLDocHandler
Returns information about the handler, such as author, version, and copyright.
getHandlerInfo() - Method in class com.ibm.workflow.servlet.sample.StarterPEAHandler
Returns information about the handler, such as author, version, and copyright.
getHTMLDir() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
Deprecated. Use getRootURI instead.
getImageForItem(ItemType) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
getInstance() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getInstance(String, String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getInstanceHistory(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.sample.AuditTrailHandler
This custom command first retrieves the audit records for the process instance whose OID matches the 'id' parameter in the HTTP-request, and then transforms the data to XML.
getInstanceList() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getInstanceList(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getInstanceListOid() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getInstanceLists() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getInstances() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getInstances(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getItem() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getJavaApiVersionInfo() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 
getKindOfList() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getKindOfSelectedList() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getLocale() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getMemberValue(ContainerElement, String) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
getMemberValue(ReadOnlyContainer, String, String) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
getMessage() - Method in class com.ibm.workflow.servlet.client.ClientException
Returns the error message string of this exception.
getMonitor() - Method in class com.ibm.workflow.servlet.client.SessionContext.MonitorPackage
 
getMonitor(int) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getMonitorListSize() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getMonitorName(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getName() - Method in class com.ibm.workflow.servlet.client.SessionContext.MonitorPackage
 
getNestedException() - Method in class com.ibm.workflow.servlet.client.ClientException
Returns the nested exception, if any.
getNumberOfInstanceLists() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getNumberOfTemplateLists() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getNumberOfWorkLists() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getOid() - Method in class com.ibm.workflow.servlet.client.SessionContext.MonitorPackage
 
getOidOfMonitor(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getParameter(String, String) - Method in class com.ibm.workflow.servlet.client.Config
Query the value of a String parameter in the servlet configuration file.
getParameter(String, String, boolean) - Method in class com.ibm.workflow.servlet.client.Config
Query the value of a boolean parameter in the servlet configuration file.
getParameter(String, String, String) - Method in class com.ibm.workflow.servlet.client.Config
Query the value of a String parameter in the servlet configuration file.
getParameters(String) - Method in class com.ibm.workflow.servlet.client.Config
Query all keys in a given section of the servlet configuration file.
getPIImageForState(ExecutionState) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
getPIStringForState(ExecutionState) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getProcessInstanceNotification(String, String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getProcessInstanceNotifications() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getProcessInstanceNotifications(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getRealPath(String) - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 
getRealPIStringForState(ExecutionState) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
getRealWIStringForState(ExecutionState) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
getRedirect(String) - Method in class com.ibm.workflow.servlet.client.RequestContext
Convenience method to create a little JavaScript script which forwards to location.
getRequest() - Method in class com.ibm.workflow.servlet.client.ClientException
Returns the HTTP request that caused this exception.
getRequest() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getRequestParameter(String, String) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getRootURI() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
Query the Web Client's root URI.
getSections() - Method in class com.ibm.workflow.servlet.client.Config
Query all sections in the servlet configuration file.
getSelectedList() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getServerInfo() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 
getServletInfo() - Method in class com.ibm.workflow.servlet.client.Main
Returns information about the servlet, such as author, version, and copyright.
getServletName() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
Query the Web Client's servlet name.
getServletPath() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 
getServletVersion() - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 
getSessionContext(HttpServletRequest) - Static method in class com.ibm.workflow.servlet.client.GenericCommandHandler
This method allows subclasses to extract the SessionContext from an HTTP request object.
getSortCriteriaAssistant(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Deprecated. - this function will be redesigned in a later release
getSortCriteriaAssistantResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Deprecated. - this function will be redesigned in a later release
getStack(Throwable) - Static method in class com.ibm.workflow.servlet.client.ClientException
Returns the stack trace of an exception as string.
getStringForAuditMode(AuditSetting) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getSystemGroup() - Method in interface com.ibm.workflow.servlet.client.SessionContext
Query the system group name of the workflow user owning this session.
getSystemInfo(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Deprecated. - this function will be redesigned in a later release
getSystemInfoResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Deprecated. - this function will be redesigned in a later release
getSystemInfoResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Deprecated. - this function will be redesigned in a later release
getSystemInfoResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
Deprecated. - this function will be redesigned in a later release
getTemplate() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getTemplate(String, String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getTemplateList() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getTemplateList(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getTemplateListOid() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getTemplateLists() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getTemplates() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getTemplates(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getText(SessionContext) - Method in class com.ibm.workflow.servlet.client.Command
Query the command's text that can be used as alt text or as button label.
getTimezoneOffset() - Method in interface com.ibm.workflow.servlet.client.SessionContext
Return the offset between the client time zone and the server time zone.
getTitle() - Method in class com.ibm.workflow.servlet.client.ClientException
Returns the error title string of this exception.
getTriggerTag(RequestContext, String, String) - Method in class com.ibm.workflow.servlet.client.Command
Construct a HTML anchor (a href) tag that will cause the command to be executed.
getTriggerTagFor(int, RequestContext) - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 
getTriggerTagFor(int, RequestContext) - Method in interface com.ibm.workflow.servlet.client.CommandHandler
This method can be called by Viewers to obtain a HTML tag that triggers user-defined commands.
getTriggerTagFor(int, RequestContext) - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
Returns a String that contains HTML code to trigger a user defined command.
getTriggerTagFor(int, RequestContext) - Method in class com.ibm.workflow.servlet.sample.AuditTrailHandler
The trigger tags for the handler.
getTriggerTagFor(int, RequestContext) - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
This method can be called by Viewers to obtain a HTML tag that triggers user-defined commands.
getTriggerTagFor(int, RequestContext) - Method in class com.ibm.workflow.servlet.sample.HTMLDocHandler
Returns an HTML tag to be included in process template lists.
getURL(RequestContext, String, String, boolean) - Method in class com.ibm.workflow.servlet.client.Command
Construct a URL that will cause the command to be executed.
getURL(String) - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
Convert a URL relative to the servlet's root URI.
getUserID() - Method in interface com.ibm.workflow.servlet.client.SessionContext
Query the ID of the workflow user who owns this session.
getUserInfo(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Deprecated. - this function will be redesigned in a later release
getUserInfoResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Deprecated. - this function will be redesigned in a later release
getUserInfoResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Deprecated. - this function will be redesigned in a later release
getUserInfoResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
Deprecated. - this function will be redesigned in a later release
getViewer() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getWIImageForState(ExecutionState) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
getWIStringForState(ExecutionState) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getWorkItem() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getWorkItem(String, String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getWorkItems() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getWorkItems(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getWorkList() - Method in class com.ibm.workflow.servlet.client.RequestContext
 
getWorkList(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getWorkListOid() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
getWorkLists() - Method in interface com.ibm.workflow.servlet.client.SessionContext
 

H

HTMLDocHandler - class com.ibm.workflow.servlet.sample.HTMLDocHandler.
This class provides a link from process template lists to the HTML documentation exported from Buildtime.
HTMLDocHandler() - Constructor for class com.ibm.workflow.servlet.sample.HTMLDocHandler
 

I

init(Config) - Method in interface com.ibm.workflow.servlet.client.CommandHandler
This method is called by the Web Client in its servlet's init() method.
init(Config) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Initializes this class according to the [DefaultViewer] section in the servlet configuration file.
init(Config) - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
This method must be called by subclasses in their init() method.
init(Config) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called after the Web Client's servlet has been initialized.
init(Config) - Method in class com.ibm.workflow.servlet.sample.AuditTrailHandler
During initialization, the handler opens a JDBC connection to the MQWF runtime database (either on the local host or on a remote host [depending on the presence of the 'DB2Server' property in the configuration file]).
init(Config) - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
This method is called by the Web Client in its servlet's init() method.
init(Config) - Method in class com.ibm.workflow.servlet.sample.EmailHandler
Initializes the handler and caches the SMTP host, if configured.
init(Config) - Method in class com.ibm.workflow.servlet.sample.StarterPEAHandler
Initializes the handler and caches the Web user, if configured.
init(ServletConfig) - Method in class com.ibm.workflow.servlet.client.Main
Initializes the servlet and places it into service.
INSTANCELIST - Static variable in interface com.ibm.workflow.servlet.client.SessionContext
 
InternetConnectionViewer - class com.ibm.workflow.servlet.sample.InternetConnectionViewer.
This Viewer mimics the look and feel of the Internet Connection for IBM FlowMark V2.
InternetConnectionViewer() - Constructor for class com.ibm.workflow.servlet.sample.InternetConnectionViewer
 
ITEM_DELETE - Static variable in class com.ibm.workflow.servlet.client.Command
Command for Item.delete()
ITEM_TRANSFER - Static variable in class com.ibm.workflow.servlet.client.Command
Command for Item.transfer(java.lang.String)

J

JSPViewer - class com.ibm.workflow.servlet.client.JSPViewer.
This Viewer should be used when your Application server supports the JSP V1.0 standard.
JSPViewer() - Constructor for class com.ibm.workflow.servlet.client.JSPViewer
 

L

LIST_DELETE - Static variable in class com.ibm.workflow.servlet.client.Command
Command for PersistentList.delete()
LIST_QUERY_LISTS - Static variable in class com.ibm.workflow.servlet.client.Command
Command to query all persistent lists
LIST_SHOW_PROPERTIES - Static variable in class com.ibm.workflow.servlet.client.Command
Command to show a persistent list's properties
LISTS - Static variable in interface com.ibm.workflow.servlet.client.SessionContext
 
loadTemplateFile(String, Properties) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
log(String, boolean) - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 
log(String, Throwable) - Method in interface com.ibm.workflow.servlet.client.ApplicationContext
 
loggedOnAs(String, String, String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
logoff(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Logs off from to the MQSeries Workflow system.
logoffResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is shown after logoff.
logoffResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that is shown after logoff.
logoffResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.logoff() command.
logon(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Logs on to the MQSeries Workflow system.
logon3(ExecutionService, byte[], SessionMode, AbsenceIndicator) - Method in interface com.ibm.workflow.servlet.client.CommandHandler
Deprecated. This method will no longer be called when using MQSeries Workflow V3.3 which provides an authentication exit for the Administration server.
logon3(ExecutionService, byte[], SessionMode, AbsenceIndicator) - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
Deprecated. This method will no longer be called when using MQSeries Workflow V3.3 which provides an authentication exit for the Administration server.
logon3(ExecutionService, byte[], SessionMode, AbsenceIndicator) - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
Deprecated. This method will no longer be called when using MQSeries Workflow V3.3 which provides an authentication exit for the Administration server.
logon3(ExecutionService, byte[], SessionMode, AbsenceIndicator) - Method in class com.ibm.workflow.servlet.sample.BasicAuthenticationHandler
Deprecated. This method will no longer be called when using MQSeries Workflow V3.3 which provides an authentication exit for the Administration server.
logonResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed after a successful logon.
logonResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that is displayed after a successful logon.
logonResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.logon() command.
logonResponse(RequestContext) - Method in class com.ibm.workflow.servlet.sample.InternetConnectionViewer
This method is called to create the response page for the BuiltinHandler.logon() command.

M

Main - class com.ibm.workflow.servlet.client.Main.
This is the main class of the MQSeries Workflow Web Client.
Main() - Constructor for class com.ibm.workflow.servlet.client.Main
 
MIMETYPE_HTML - Static variable in class com.ibm.workflow.servlet.client.ResponsePage
Constant for text/html
MIMETYPE_JPEG - Static variable in class com.ibm.workflow.servlet.client.ResponsePage
Constant for image/jpeg
MIMETYPE_WML - Static variable in class com.ibm.workflow.servlet.client.ResponsePage
Constant for text/vnd.wap.wml
MIMETYPE_XML - Static variable in class com.ibm.workflow.servlet.client.ResponsePage
Constant for text/xml

N

NoSessionException - exception com.ibm.workflow.servlet.client.NoSessionException.
This exception will be thrown if the servlet's service() method is called for a command other than logon, but no Workflow SessionContext is found in the request's HttpSession object.
NoSessionException(HttpServletRequest) - Constructor for class com.ibm.workflow.servlet.client.NoSessionException
Constructs a NoSessionException object.
NOT_SET - Static variable in interface com.ibm.workflow.servlet.client.SessionContext
 
null2Empty(String) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 

O

onLogoff(SessionContext) - Method in interface com.ibm.workflow.servlet.client.CommandHandler
This method is called whenever a user has logged off.
onLogoff(SessionContext) - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
This hook has an empty implementation.
onLogoff(SessionContext) - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
This method is called whenever a user has logged off.
onLogoff(SessionContext) - Method in class com.ibm.workflow.servlet.sample.StarterPEAHandler
Shuts down the Web user's PEA if called for the Web user ID.
onLogon(RequestContext) - Method in interface com.ibm.workflow.servlet.client.CommandHandler
This method is called whenever a new user has logged on.
onLogon(RequestContext) - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
To provide for backward compatibility, this hook will call GenericCommandHandler.onLogon(SessionContext).
onLogon(RequestContext) - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
This method is called whenever a new user has logged on.
onLogon(RequestContext) - Method in class com.ibm.workflow.servlet.sample.StarterPEAHandler
Start the Web user's PEA called for the Web user ID and if enabled in WebClient.properties.
onLogon(SessionContext) - Method in interface com.ibm.workflow.servlet.client.CommandHandler
Deprecated. Use CommandHandler.onLogon(com.ibm.workflow.servlet.client.RequestContext) instead.
onLogon(SessionContext) - Method in class com.ibm.workflow.servlet.client.GenericCommandHandler
Deprecated. Use GenericCommandHandler.onLogon(RequestContext) instead.
onLogon(SessionContext) - Method in class com.ibm.workflow.servlet.sample.CommandHandlerAdapter
Deprecated. Use CommandHandlerAdapter.onLogon(RequestContext) instead.
openForm(String) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
openForm(String, String) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
openPage(String, int) - Method in class com.ibm.workflow.servlet.client.RequestContext
 

P

persistentOidOf(PersistentList) - Static method in class com.ibm.workflow.servlet.client.RequestContext
Deprecated. This method will be removed with MQWF V3.3 where PersistentList.persistentOid() can be used.
PI_DELETE - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessInstance.delete()
PI_RESTART - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessInstance.restart()
PI_RESUME - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessInstance.resume(boolean)
PI_SHOW_MONITOR - Static variable in class com.ibm.workflow.servlet.client.Command
Command to show a process instance monitor
PI_SHOW_PROPERTIES - Static variable in class com.ibm.workflow.servlet.client.Command
Command to show process instance properties
PI_START - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessInstance.start()
PI_SUSPEND - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessInstance.suspend(boolean)
PI_TERMINATE - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessInstance.terminate()
PIL_QUERY_INSTANCES - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessInstanceList.queryProcessInstances()
printStackTrace(PrintStream) - Method in class com.ibm.workflow.servlet.client.ClientException
Prints this exception to the specified print stream.
printStackTrace(PrintWriter) - Method in class com.ibm.workflow.servlet.client.ClientException
Prints this exception to the specified print writer.
PT_CREATE_AND_START_INSTANCE - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessTemplate.createAndStartInstance(java.lang.String, java.lang.String, java.lang.String, boolean)
PT_CREATE_INSTANCE - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessTemplate.createInstance(java.lang.String, java.lang.String, java.lang.String, boolean)
PT_DELETE - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessTemplate.delete()
PT_SHOW_PROPERTIES - Static variable in class com.ibm.workflow.servlet.client.Command
Command to show process template properties
PTL_QUERY_TEMPLATES - Static variable in class com.ibm.workflow.servlet.client.Command
Command for ProcessTemplateList.queryProcessTemplates()

Q

queryLists(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Deprecated. - this function will be redesigned in a later release
queryListsResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
 
queryListsResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays the list of lists.
queryListsResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.queryLists() command.
queryProcessInstanceLists(RequestContext) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
queryProcessInstances(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Queries the process instances on the specified instance list.
queryProcessInstances(RequestContext, String, boolean) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Queries the process instances of the specified instance list.
queryProcessInstancesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that displays a process instance list.
queryProcessInstancesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays a process instance list.
queryProcessInstancesResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.queryProcessInstances() command.
queryProcessTemplateLists(RequestContext) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
queryProcessTemplates(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Queries the process templates on the specified template list.
queryProcessTemplates(RequestContext, String, boolean) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Queries the process templates of the specified template list.
queryProcessTemplatesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that displays a process template list.
queryProcessTemplatesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays a process template list.
queryProcessTemplatesResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.queryProcessTemplates() command.
queryWorkItems(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Queries the work items on the specified worklist.
queryWorkItems(RequestContext, String, boolean) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Queries the work items of the specified worklist.
queryWorkItemsResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that displays a work list.
queryWorkItemsResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays a worklist.
queryWorkItemsResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.queryWorkItems() command.
queryWorkItemsResponse(RequestContext) - Method in class com.ibm.workflow.servlet.sample.InternetConnectionViewer
This method is called to create the response page for the BuiltinHandler.queryWorkItems() command.
queryWorkLists(RequestContext) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 

R

removeAllMonitorsUpto(String, boolean) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
render(String, RequestContext) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
replaceInString(String, String, String) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
RequestContext - class com.ibm.workflow.servlet.client.RequestContext.
 
RequestContext(HttpServletRequest) - Constructor for class com.ibm.workflow.servlet.client.RequestContext
 
ResponsePage - class com.ibm.workflow.servlet.client.ResponsePage.
Objects of this class represent the responses sent by the Web Client.
ResponsePage(byte[], String) - Constructor for class com.ibm.workflow.servlet.client.ResponsePage
Create a response page from a byte array.
ResponsePage(byte[], String, long) - Constructor for class com.ibm.workflow.servlet.client.ResponsePage
Create a response page from a byte array.
ResponsePage(RequestContext, String) - Constructor for class com.ibm.workflow.servlet.client.ResponsePage
Create a response page from a URL.
ResponsePage(RequestContext, String, long) - Constructor for class com.ibm.workflow.servlet.client.ResponsePage
Create a response page from a URL.
ResponsePage(StringBuffer) - Constructor for class com.ibm.workflow.servlet.client.ResponsePage
Create a response page from a StringBuffer.
ResponsePage(StringBuffer, String) - Constructor for class com.ibm.workflow.servlet.client.ResponsePage
Create a response page from a StringBuffer.
ResponsePage(StringBuffer, String, long) - Constructor for class com.ibm.workflow.servlet.client.ResponsePage
Create a response page from a StringBuffer.
restartInstance(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
restartInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page displayed after a process instance has been restarted.
restartInstanceResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.restartInstance() command.
restartWorkItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
restartWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when a work item has been restarted.
restartWorkItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.restartWorkItem() command.
resumeInstance(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
resumeInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page displayed after a process instance has been resumed.
resumeInstanceResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.resumeInstance() command.

S

SESSION_KEY - Static variable in interface com.ibm.workflow.servlet.client.SessionContext
 
SessionContext - interface com.ibm.workflow.servlet.client.SessionContext.
 
SessionContext.MonitorPackage - class com.ibm.workflow.servlet.client.SessionContext.MonitorPackage.
 
SessionContext.MonitorPackage(String, String, ProcessMonitor) - Constructor for class com.ibm.workflow.servlet.client.SessionContext.MonitorPackage
 
setActivityInstance(ActivityInstance) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setActivityInstanceNotifications(WorkList, ActivityInstanceNotification[]) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setAttribute(String, Object) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setContainer(ReadOnlyContainer) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setControlConnectorInstance(ControlConnectorInstance) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setException(ClientException) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setExpiryDate(long) - Method in class com.ibm.workflow.servlet.client.ResponsePage
Set the expiry date of the reponse page.
setInstance(ProcessInstance) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setInstanceListOid(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
setInstances(ProcessInstanceList, ProcessInstance[]) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setItem(Item) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setKindOfList(int) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
setKindOfSelectedList(int) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
setListProperties(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
setListPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
 
setListPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays the list of lists.
setListPropertiesResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.setListProperties() command.
setLocale(Locale) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
setMimeType(String) - Method in class com.ibm.workflow.servlet.client.ResponsePage
Set the MIME type of the reponse page.
setProcessInstanceNotifications(WorkList, ProcessInstanceNotification[]) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setSelectedList(PersistentList) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
setTemplate(ProcessTemplate) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setTemplateListOid(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
setTemplates(ProcessTemplateList, ProcessTemplate[]) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setUserSettings(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Deprecated. - this function will be redesigned in a later release
setUserSettingsResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Deprecated. - this function will be redesigned in a later release
setUserSettingsResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
Deprecated. - this function will be redesigned in a later release
setViewer(Viewer) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
setViewSettings(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Deprecated. - this function will be redesigned in a later release
setViewSettingsResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Deprecated. - this function will be redesigned in a later release
setViewSettingsResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
Deprecated. - this function will be redesigned in a later release
setWorkItem(WorkItem) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setWorkItems(WorkList, WorkItem[]) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
setWorkListOid(String) - Method in interface com.ibm.workflow.servlet.client.SessionContext
 
showActivityProperties(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
showActivityPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
This method has an empty implementation since activity properties can only be accessed from within the process monitor which requires JSPViewer.
showActivityPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays activity instance properties.
showActivityPropertiesResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.showActivityProperties() command.
showControlConnectorProperties(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
showControlConnectorPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
This method has an empty implementation since connector properties can only be accessed from within the process monitor which requires JSPViewer.
showControlConnectorPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays control connector properties.
showControlConnectorPropertiesResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.showControlConnectorProperties() command.
showInstanceProperties(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
showInstancePropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that displays process instance properties.
showInstancePropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays process instance properties.
showInstancePropertiesResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.showInstanceProperties() command.
showListProperties(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
showListPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
 
showListPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays list settings.
showListPropertiesResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.showListProperties() command.
showTemplateProperties(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
showTemplatePropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that displays process template properties.
showTemplatePropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays process template properties.
showTemplatePropertiesResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.showTemplateProperties() command.
showWorkItemProperties(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
showWorkItemPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that displays work item properties.
showWorkItemPropertiesResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that displays work item properties.
showWorkItemPropertiesResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.showWorkItemProperties() command.
StarterPEAHandler - class com.ibm.workflow.servlet.sample.StarterPEAHandler.
This CommandHandler automatically starts and stops the Program Execution Agent for the Web user.
StarterPEAHandler() - Constructor for class com.ibm.workflow.servlet.sample.StarterPEAHandler
 
startInstance(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
startInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that will be displayed after a process instance has been started.
startInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that will be displayed after a process instance has been started.
startInstanceResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.startInstance() command.
startWorkItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
startWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when a work item has been started.
startWorkItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.startWorkItem() command.
suspendInstance(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Suspends a process instance.
suspendInstance(RequestContext, String, String, boolean, String, String, String, String, String) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
Suspends a process instance.
suspendInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page displayed after a process instance has been suspended.
suspendInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that is displayed after a process instance has been suspended.
suspendInstanceResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.suspendInstance() command.

T

TEMPLATELIST - Static variable in interface com.ibm.workflow.servlet.client.SessionContext
 
terminateActivity(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
terminateActivityResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
This method has an empty implementation since activity actions can only be accessed from activity properties page which requires JSPViewer.
terminateActivityResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.JSPViewer
Creates the page that is displayed after an activity instance has been terminated.
terminateActivityResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.terminateActivity() command.
terminateInstance(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
terminateInstanceResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page displayed after a process instance has been terminated.
terminateInstanceResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.terminateInstance() command.
terminateWorkItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
terminateWorkItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when a work item has been terminated.
terminateWorkItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.terminateWorkItem() command.
toHTMLText(String) - Static method in class com.ibm.workflow.servlet.client.RequestContext
Quotes characters that have a special meaning in HTML.
toJavaScriptString(String, char) - Static method in class com.ibm.workflow.servlet.client.RequestContext
 
toString(AssignReason) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
toString(Calendar) - Method in interface com.ibm.workflow.servlet.client.SessionContext
Formats a server date according to the DateFormat and TimeFormat settings in WebClient.properties.
toString(ItemType) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
toString(Type) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
toString(Type) - Method in class com.ibm.workflow.servlet.client.RequestContext
 
transferItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
transferItem(HttpServletRequest, HttpServletResponse) - Method in class com.ibm.workflow.servlet.sample.EmailHandler
Service entry point to which the 'x-transferItem' requests issued by the ListViewer.jsp are dispatched.
transferItem(RequestContext, String, String, String) - Method in class com.ibm.workflow.servlet.client.BuiltinHandler
 
transferItemResponse(RequestContext) - Method in class com.ibm.workflow.servlet.client.DefaultViewer
Creates the page that is displayed when an item has been transferred.
transferItemResponse(RequestContext) - Method in interface com.ibm.workflow.servlet.client.Viewer
This method is called to create the response page for the BuiltinHandler.transferItem() command.

V

Viewer - interface com.ibm.workflow.servlet.client.Viewer.
This class allows you to customize the look and feel of certain parts of the Web Client.

W

WI_CANCEL_CHECKOUT - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkItem.cancelCheckOut()
WI_CHECKIN - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkItem.checkIn(com.ibm.workflow.api.ReadWriteContainer, int)
WI_CHECKOUT - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkItem.checkOut()
WI_FINISH - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkItem.finish()
WI_FORCE_FINISH - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkItem.forceFinish()
WI_FORCE_RESTART - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkItem.forceRestart()
WI_RESTART - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkItem.restart()
WI_SHOW_PROPERTIES - Static variable in class com.ibm.workflow.servlet.client.Command
Command to show work item properties
WI_START - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkItem.start()
WI_TERMINATE - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkItem.terminate()
withParameter(String) - Method in class com.ibm.workflow.servlet.client.Command
Creates a new command with the same attributes and a new parameter.
withPrompt(String, String) - Method in class com.ibm.workflow.servlet.client.Command
Creates a new command with the same attributes and a new prompt.
withText(String) - Method in class com.ibm.workflow.servlet.client.Command
Creates a new command with the same attributes and a new text.
WL_QUERY_WORK_ITEMS - Static variable in class com.ibm.workflow.servlet.client.Command
Command for WorkList.queryWorkItems()
WORKLIST - Static variable in interface com.ibm.workflow.servlet.client.SessionContext
 

A B C D E F G H I J L M N O P Q R S T V W

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