com.ibm.workflow.servlet.client
Class RequestContext

java.lang.Object
  |
  +--com.ibm.workflow.servlet.client.ApplicationContextProxy
        |
        +--com.ibm.workflow.servlet.client.SessionContextProxy
              |
              +--com.ibm.workflow.servlet.client.RequestContext
All Implemented Interfaces:
ApplicationContext, Catalog, SessionContext

public class RequestContext
extends SessionContextProxy
implements SessionContext


Inner classes inherited from class com.ibm.workflow.servlet.client.SessionContext
SessionContext.MonitorPackage
 
Fields inherited from interface com.ibm.workflow.servlet.client.SessionContext
ACTIVITYINSTANCELIST, INSTANCELIST, LISTS, NOT_SET, SESSION_KEY, TEMPLATELIST, WORKLIST
 
Constructor Summary
RequestContext(javax.servlet.http.HttpServletRequest request)
           
 
Method Summary
static java.lang.String formatStringArray(java.lang.String[] txt, java.lang.String between)
           
 java.lang.StringBuffer generateForm(Command submit, java.lang.String submitOid, Command cancel, java.lang.String cancelOid, com.ibm.workflow.api.Container from, com.ibm.workflow.api.Container to, java.lang.String instanceName, java.lang.String RC)
           
 com.ibm.workflow.api.ActivityInstance[] getActivities()
           
 com.ibm.workflow.api.ActivityInstance getActivityInstance()
           
 com.ibm.workflow.api.ActivityInstanceList getActivityInstanceList()
           
 com.ibm.workflow.api.ActivityInstanceNotification[] getActivityInstanceNotifications()
           
static java.lang.String getAIImageForState(com.ibm.workflow.api.ActivityInstancePackage.ExecutionState state)
           
 java.lang.String getAIStringForState(com.ibm.workflow.api.ActivityInstancePackage.ExecutionState state)
           
 java.lang.Object getAttribute(java.lang.String name)
           
 Catalog getCatalog(java.lang.String bundleName)
           
 java.lang.String getCIStringForState(com.ibm.workflow.api.ControlConnectorInstancePackage.EvaluationState state)
           
 com.ibm.workflow.api.ReadOnlyContainer getContainer()
           
 com.ibm.workflow.api.ControlConnectorInstance getControlConnectorInstance()
           
 ClientException getException()
           
 com.ibm.workflow.api.ReadOnlyContainer getGlobalContainer()
           
static java.lang.String getImageForItem(com.ibm.workflow.api.ItemPackage.ItemType t)
           
 com.ibm.workflow.api.ProgramTemplatePackage.ImplementationData[] getImplementationData()
           
 com.ibm.workflow.api.ProcessInstance getInstance()
           
 com.ibm.workflow.api.ProcessInstanceList getInstanceList()
           
 com.ibm.workflow.api.ProcessInstance[] getInstances()
           
 com.ibm.workflow.api.Item getItem()
           
static java.lang.String getMemberValue(Catalog cat, com.ibm.workflow.api.ContainerElement member, java.lang.String notSet)
           
static java.lang.String getMemberValue(Catalog cat, com.ibm.workflow.api.ReadOnlyContainer container, java.lang.String member, java.lang.String notSet)
           
 java.lang.String getMemberValue(com.ibm.workflow.api.ContainerElement member, java.lang.String notSet)
           
 java.lang.String getMemberValue(com.ibm.workflow.api.ReadOnlyContainer container, java.lang.String member, java.lang.String notSet)
           
 java.lang.String getMessage()
           
static java.lang.String getPIImageForState(com.ibm.workflow.api.ProcessInstancePackage.ExecutionState state)
           
 java.lang.String getPIStringForState(com.ibm.workflow.api.ProcessInstancePackage.ExecutionState state)
           
 com.ibm.workflow.api.ProcessInstanceNotification[] getProcessInstanceNotifications()
           
static java.lang.String getRealAIStringForState(com.ibm.workflow.api.ActivityInstancePackage.ExecutionState state)
           
static java.lang.String getRealPIStringForState(com.ibm.workflow.api.ProcessInstancePackage.ExecutionState state)
           
static java.lang.String getRealWIStringForState(com.ibm.workflow.api.ItemPackage.ExecutionState state)
           
static java.lang.StringBuffer getRedirect(Catalog cat, java.lang.String location)
           
 java.lang.StringBuffer getRedirect(java.lang.String location)
          Convenience method to create a little JavaScript script which forwards to location.
 javax.servlet.http.HttpServletRequest getRequest()
           
 java.lang.String getRequestParameter(java.lang.String name, java.lang.String defaultValue)
           
 java.lang.String getRequestParameter(java.lang.String name, java.lang.String defaultValue, java.lang.String charset)
           
 java.lang.Integer getResultSize()
           
 java.lang.String getStringForAuditMode(com.ibm.workflow.api.ProcessTemplatePackage.AuditSetting audit)
           
 com.ibm.workflow.api.ProcessTemplate getTemplate()
           
 com.ibm.workflow.api.ProcessTemplateList getTemplateList()
           
 com.ibm.workflow.api.ProcessTemplate[] getTemplates()
           
static java.lang.String getWIImageForState(com.ibm.workflow.api.ItemPackage.ExecutionState state)
           
 java.lang.String getWIStringForState(com.ibm.workflow.api.ItemPackage.ExecutionState state)
           
 com.ibm.workflow.api.WorkItem getWorkItem()
           
 com.ibm.workflow.api.WorkItem[] getWorkItems()
           
 com.ibm.workflow.api.WorkList getWorkList()
           
 java.lang.StringBuffer loadTemplateFile(java.lang.String urlname, java.util.Properties vars)
           
 int mostRecentList(boolean enableWorklists, boolean enableInstancelists, boolean enableTemplatelists, boolean enableLists, boolean useCache)
           
static java.lang.String null2Empty(java.lang.String value)
           
 java.lang.StringBuffer openForm(java.lang.String command)
           
 java.lang.StringBuffer openForm(java.lang.String command, java.lang.String id)
           
 java.lang.StringBuffer openForm(java.lang.String command, java.lang.String id, java.lang.String attributes)
           
 java.lang.StringBuffer openPage(java.lang.String title, int size)
           
static java.lang.String replaceInString(java.lang.String buffer, java.lang.String oldString, java.lang.String newString)
           
 void setActivities(com.ibm.workflow.api.ActivityInstanceList activityList, com.ibm.workflow.api.ActivityInstance[] activities)
           
 void setActivityInstance(com.ibm.workflow.api.ActivityInstance activity)
           
 void setActivityInstanceNotifications(com.ibm.workflow.api.WorkList workList, com.ibm.workflow.api.ActivityInstanceNotification[] items)
           
 void setAttribute(java.lang.String name, java.lang.Object value)
           
 void setContainer(com.ibm.workflow.api.ReadOnlyContainer container)
           
 void setControlConnectorInstance(com.ibm.workflow.api.ControlConnectorInstance controlConnector)
           
 void setException(ClientException xcpt)
           
 void setImplementationData(com.ibm.workflow.api.ProgramTemplatePackage.ImplementationData[] impData)
           
 void setInstance(com.ibm.workflow.api.ProcessInstance instance)
           
 void setInstances(com.ibm.workflow.api.ProcessInstanceList instanceList, com.ibm.workflow.api.ProcessInstance[] instances)
           
 void setItem(com.ibm.workflow.api.Item item)
           
 void setProcessInstanceNotifications(com.ibm.workflow.api.WorkList workList, com.ibm.workflow.api.ProcessInstanceNotification[] items)
           
 void setResultSize(java.lang.Integer integer)
           
 void setTemplate(com.ibm.workflow.api.ProcessTemplate template)
           
 void setTemplates(com.ibm.workflow.api.ProcessTemplateList templateList, com.ibm.workflow.api.ProcessTemplate[] templates)
           
 void setWorkItem(com.ibm.workflow.api.WorkItem workItem)
           
 void setWorkItems(com.ibm.workflow.api.WorkList workList, com.ibm.workflow.api.WorkItem[] workItems)
           
static java.lang.String toHTMLText(java.lang.String value, java.lang.String empty)
          Quotes characters that have a special meaning in HTML.
static java.lang.String toJavaScriptString(java.lang.String value, char quote)
           
 java.lang.String toString(com.ibm.workflow.api.ItemPackage.AssignReason r)
           
 java.lang.String toString(com.ibm.workflow.api.ItemPackage.ItemType t)
           
 java.lang.String toString(com.ibm.workflow.api.ActivityInstancePackage.Type t)
           
 java.lang.String toString(com.ibm.workflow.api.ControlConnectorInstancePackage.Type t)
           
 
Methods inherited from class com.ibm.workflow.servlet.client.SessionContextProxy
get, get, get, getActivityInstance, getActivityInstance, getActivityInstanceList, getActivityInstanceListOid, getActivityInstanceLists, getActivityInstanceNotification, getActivityInstanceNotifications, getActivityInstances, getActivityList, getCommand, getCommand, getCommand, getControlConnectorInstance, getCurrentUser, getExecutionService, getHTMLAlignment, getHTMLDirection, getInstance, getInstanceList, getInstanceListOid, getInstanceLists, getInstances, getKindOfList, getKindOfSelectedList, getLocale, getLocalizedGifName, getMonitor, getMonitorListSize, getMonitorName, getNumberOfActivityInstanceLists, getNumberOfInstanceLists, getNumberOfTemplateLists, getNumberOfWorkLists, getOidOfMonitor, getProcessInstanceNotification, getProcessInstanceNotifications, getSelectedList, getServletName, getServletPath, getSystemGroup, getTemplate, getTemplateList, getTemplateListOid, getTemplateLists, getTemplates, getTimezoneOffset, getUserID, getViewer, getWorkItem, getWorkItems, getWorkList, getWorkListOid, getWorkLists, loggedOnAs, removeAllMonitorsUpto, setActivityInstanceListOid, setCurrentUser, setInstanceListOid, setKindOfList, setKindOfSelectedList, setLocale, setLocale, setSelectedList, setTemplateListOid, setViewer, setWorkListOid, toString
 
Methods inherited from class com.ibm.workflow.servlet.client.ApplicationContextProxy
formatDate, formatTime, getAgent, getBuiltinHandler, getConfig, getDocumentRoot, getJavaApiVersionInfo, getRealPath, getRootURI, getServerInfo, getServletVersion, getTriggerTagFor, getURL, isDebugEnabled, isUsingJNDI, log, log, useQueryResultSize
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.workflow.servlet.client.SessionContext
getActivityInstance, getActivityInstance, getActivityInstanceList, getActivityInstanceListOid, getActivityInstanceNotification, getActivityInstanceNotifications, getActivityInstances, getActivityList, getCommand, getCommand, getCommand, getControlConnectorInstance, getCurrentUser, getExecutionService, getInstance, getInstanceList, getInstanceListOid, getInstanceLists, getInstances, getKindOfList, getKindOfSelectedList, getLocale, getMonitor, getMonitorListSize, getMonitorName, getNumberOfActivityInstanceLists, getNumberOfInstanceLists, getNumberOfTemplateLists, getNumberOfWorkLists, getOidOfMonitor, getProcessInstanceNotification, getProcessInstanceNotifications, getSelectedList, getServletName, getServletPath, getSystemGroup, getTemplate, getTemplateList, getTemplateListOid, getTemplateLists, getTemplates, getTimezoneOffset, getUserID, getViewer, getWorkItem, getWorkItems, getWorkList, getWorkListOid, getWorkLists, loggedOnAs, removeAllMonitorsUpto, setCurrentUser, setInstanceListOid, setKindOfList, setKindOfSelectedList, setLocale, setLocale, setSelectedList, setTemplateListOid, setViewer, setWorkListOid, toString
 
Methods inherited from interface com.ibm.workflow.servlet.client.Catalog
get, get, get
 
Methods inherited from interface com.ibm.workflow.servlet.client.ApplicationContext
formatDate, formatTime, getAgent, getBuiltinHandler, getConfig, getDocumentRoot, getJavaApiVersionInfo, getRealPath, getRootURI, getServerInfo, getServletVersion, getTriggerTagFor, getURL, isDebugEnabled, isUsingJNDI, log, log, useQueryResultSize
 

Constructor Detail

RequestContext

public RequestContext(javax.servlet.http.HttpServletRequest request)
               throws ClientException
Method Detail

null2Empty

public static final java.lang.String null2Empty(java.lang.String value)

toHTMLText

public static final java.lang.String toHTMLText(java.lang.String value,
                                                java.lang.String empty)
Quotes characters that have a special meaning in HTML. (Replacing '<' by '&lt;' and so on.)
Parameters:
value - the string to quote
Returns:
the html parameter

toJavaScriptString

public static java.lang.String toJavaScriptString(java.lang.String value,
                                                  char quote)

getCatalog

public Catalog getCatalog(java.lang.String bundleName)

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

getRequest

public final javax.servlet.http.HttpServletRequest getRequest()

getRequestParameter

public java.lang.String getRequestParameter(java.lang.String name,
                                            java.lang.String defaultValue)

getRequestParameter

public java.lang.String getRequestParameter(java.lang.String name,
                                            java.lang.String defaultValue,
                                            java.lang.String charset)

getMessage

public java.lang.String getMessage()

mostRecentList

public int mostRecentList(boolean enableWorklists,
                          boolean enableInstancelists,
                          boolean enableTemplatelists,
                          boolean enableLists,
                          boolean useCache)
                   throws ClientException

getTemplateList

public com.ibm.workflow.api.ProcessTemplateList getTemplateList()

getTemplates

public com.ibm.workflow.api.ProcessTemplate[] getTemplates()

setTemplates

public void setTemplates(com.ibm.workflow.api.ProcessTemplateList templateList,
                         com.ibm.workflow.api.ProcessTemplate[] templates)

getTemplate

public com.ibm.workflow.api.ProcessTemplate getTemplate()

setTemplate

public void setTemplate(com.ibm.workflow.api.ProcessTemplate template)

getInstanceList

public com.ibm.workflow.api.ProcessInstanceList getInstanceList()

getInstances

public com.ibm.workflow.api.ProcessInstance[] getInstances()

setInstances

public void setInstances(com.ibm.workflow.api.ProcessInstanceList instanceList,
                         com.ibm.workflow.api.ProcessInstance[] instances)

getInstance

public com.ibm.workflow.api.ProcessInstance getInstance()

setInstance

public void setInstance(com.ibm.workflow.api.ProcessInstance instance)

getWorkList

public com.ibm.workflow.api.WorkList getWorkList()

getProcessInstanceNotifications

public com.ibm.workflow.api.ProcessInstanceNotification[] getProcessInstanceNotifications()

setProcessInstanceNotifications

public void setProcessInstanceNotifications(com.ibm.workflow.api.WorkList workList,
                                            com.ibm.workflow.api.ProcessInstanceNotification[] items)

getActivityInstanceNotifications

public com.ibm.workflow.api.ActivityInstanceNotification[] getActivityInstanceNotifications()

setActivityInstanceNotifications

public void setActivityInstanceNotifications(com.ibm.workflow.api.WorkList workList,
                                             com.ibm.workflow.api.ActivityInstanceNotification[] items)

getWorkItems

public com.ibm.workflow.api.WorkItem[] getWorkItems()

setWorkItems

public void setWorkItems(com.ibm.workflow.api.WorkList workList,
                         com.ibm.workflow.api.WorkItem[] workItems)

getWorkItem

public com.ibm.workflow.api.WorkItem getWorkItem()

setWorkItem

public void setWorkItem(com.ibm.workflow.api.WorkItem workItem)

getItem

public com.ibm.workflow.api.Item getItem()

setItem

public void setItem(com.ibm.workflow.api.Item item)

getGlobalContainer

public com.ibm.workflow.api.ReadOnlyContainer getGlobalContainer()
                                                          throws ClientException

getContainer

public com.ibm.workflow.api.ReadOnlyContainer getContainer()

setContainer

public void setContainer(com.ibm.workflow.api.ReadOnlyContainer container)

getImplementationData

public com.ibm.workflow.api.ProgramTemplatePackage.ImplementationData[] getImplementationData()

setImplementationData

public void setImplementationData(com.ibm.workflow.api.ProgramTemplatePackage.ImplementationData[] impData)

getException

public ClientException getException()

setException

public void setException(ClientException xcpt)

setActivities

public void setActivities(com.ibm.workflow.api.ActivityInstanceList activityList,
                          com.ibm.workflow.api.ActivityInstance[] activities)

getActivityInstance

public com.ibm.workflow.api.ActivityInstance getActivityInstance()

getActivityInstanceList

public com.ibm.workflow.api.ActivityInstanceList getActivityInstanceList()

getActivities

public com.ibm.workflow.api.ActivityInstance[] getActivities()

setActivityInstance

public void setActivityInstance(com.ibm.workflow.api.ActivityInstance activity)

getControlConnectorInstance

public com.ibm.workflow.api.ControlConnectorInstance getControlConnectorInstance()

setControlConnectorInstance

public void setControlConnectorInstance(com.ibm.workflow.api.ControlConnectorInstance controlConnector)

getRedirect

public java.lang.StringBuffer getRedirect(java.lang.String location)
Convenience method to create a little JavaScript script which forwards to location. Returns a buffer containing
<script language="JavaScript"> location="location" </script>
Parameters:
location - Where to forward the request to
Returns:
A buffer containing the JavaScript script.

getRedirect

public static java.lang.StringBuffer getRedirect(Catalog cat,
                                                 java.lang.String location)

openPage

public java.lang.StringBuffer openPage(java.lang.String title,
                                       int size)

openForm

public java.lang.StringBuffer openForm(java.lang.String command)

openForm

public java.lang.StringBuffer openForm(java.lang.String command,
                                       java.lang.String id)

openForm

public java.lang.StringBuffer openForm(java.lang.String command,
                                       java.lang.String id,
                                       java.lang.String attributes)

loadTemplateFile

public java.lang.StringBuffer loadTemplateFile(java.lang.String urlname,
                                               java.util.Properties vars)
                                        throws java.io.IOException

generateForm

public java.lang.StringBuffer generateForm(Command submit,
                                           java.lang.String submitOid,
                                           Command cancel,
                                           java.lang.String cancelOid,
                                           com.ibm.workflow.api.Container from,
                                           com.ibm.workflow.api.Container to,
                                           java.lang.String instanceName,
                                           java.lang.String RC)
                                    throws com.ibm.workflow.api.FmcException

replaceInString

public static java.lang.String replaceInString(java.lang.String buffer,
                                               java.lang.String oldString,
                                               java.lang.String newString)

getMemberValue

public java.lang.String getMemberValue(com.ibm.workflow.api.ReadOnlyContainer container,
                                       java.lang.String member,
                                       java.lang.String notSet)
                                throws com.ibm.workflow.api.FmcException

getMemberValue

public java.lang.String getMemberValue(com.ibm.workflow.api.ContainerElement member,
                                       java.lang.String notSet)
                                throws com.ibm.workflow.api.FmcException

getMemberValue

public static java.lang.String getMemberValue(Catalog cat,
                                              com.ibm.workflow.api.ReadOnlyContainer container,
                                              java.lang.String member,
                                              java.lang.String notSet)
                                       throws com.ibm.workflow.api.FmcException

getMemberValue

public static java.lang.String getMemberValue(Catalog cat,
                                              com.ibm.workflow.api.ContainerElement member,
                                              java.lang.String notSet)
                                       throws com.ibm.workflow.api.FmcException

toString

public java.lang.String toString(com.ibm.workflow.api.ItemPackage.ItemType t)

getImageForItem

public static java.lang.String getImageForItem(com.ibm.workflow.api.ItemPackage.ItemType t)

toString

public java.lang.String toString(com.ibm.workflow.api.ActivityInstancePackage.Type t)

toString

public java.lang.String toString(com.ibm.workflow.api.ControlConnectorInstancePackage.Type t)

toString

public java.lang.String toString(com.ibm.workflow.api.ItemPackage.AssignReason r)

getPIImageForState

public static java.lang.String getPIImageForState(com.ibm.workflow.api.ProcessInstancePackage.ExecutionState state)

getWIImageForState

public static java.lang.String getWIImageForState(com.ibm.workflow.api.ItemPackage.ExecutionState state)

getWIStringForState

public java.lang.String getWIStringForState(com.ibm.workflow.api.ItemPackage.ExecutionState state)

getRealWIStringForState

public static java.lang.String getRealWIStringForState(com.ibm.workflow.api.ItemPackage.ExecutionState state)

getAIStringForState

public java.lang.String getAIStringForState(com.ibm.workflow.api.ActivityInstancePackage.ExecutionState state)

getRealAIStringForState

public static java.lang.String getRealAIStringForState(com.ibm.workflow.api.ActivityInstancePackage.ExecutionState state)

getAIImageForState

public static java.lang.String getAIImageForState(com.ibm.workflow.api.ActivityInstancePackage.ExecutionState state)

getCIStringForState

public java.lang.String getCIStringForState(com.ibm.workflow.api.ControlConnectorInstancePackage.EvaluationState state)

getPIStringForState

public java.lang.String getPIStringForState(com.ibm.workflow.api.ProcessInstancePackage.ExecutionState state)

getRealPIStringForState

public static java.lang.String getRealPIStringForState(com.ibm.workflow.api.ProcessInstancePackage.ExecutionState state)

getStringForAuditMode

public java.lang.String getStringForAuditMode(com.ibm.workflow.api.ProcessTemplatePackage.AuditSetting audit)

formatStringArray

public static java.lang.String formatStringArray(java.lang.String[] txt,
                                                 java.lang.String between)

getResultSize

public java.lang.Integer getResultSize()
Returns:
 

setResultSize

public void setResultSize(java.lang.Integer integer)
Parameters:
integer -  


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