com.ibm.workflow.servlet.client
Class RequestContext

com.ibm.workflow.servlet.client.RequestContext

public class RequestContext
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
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, Container from, Container to, java.lang.String instanceName, java.lang.String RC)
           
 ActivityInstance getActivityInstance()
           
 ActivityInstanceNotification[] getActivityInstanceNotifications()
           
static java.lang.String getAIImageForState(ExecutionState state)
           
 java.lang.String getAIStringForState(ExecutionState state)
           
 java.lang.Object getAttribute(java.lang.String name)
           
 Catalog getCatalog(java.lang.String bundleName)
           
 java.lang.String getCIStringForState(EvaluationState state)
           
 ReadOnlyContainer getContainer()
           
 ControlConnectorInstance getControlConnectorInstance()
           
 ClientException getException()
           
static java.lang.String getImageForItem(ItemType t)
           
 ProcessInstance getInstance()
           
 ProcessInstanceList getInstanceList()
           
 ProcessInstance[] getInstances()
           
 Item getItem()
           
static java.lang.String getMemberValue(ContainerElement member, java.lang.String notSet)
           
static java.lang.String getMemberValue(ReadOnlyContainer container, java.lang.String member, java.lang.String notSet)
           
static java.lang.String getPIImageForState(ExecutionState state)
           
 java.lang.String getPIStringForState(ExecutionState state)
           
 ProcessInstanceNotification[] getProcessInstanceNotifications()
           
static java.lang.String getRealPIStringForState(ExecutionState state)
           
static java.lang.String getRealWIStringForState(ExecutionState state)
           
 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 getStringForAuditMode(AuditSetting audit)
           
 ProcessTemplate getTemplate()
           
 ProcessTemplateList getTemplateList()
           
 ProcessTemplate[] getTemplates()
           
static java.lang.String getWIImageForState(ExecutionState state)
           
 java.lang.String getWIStringForState(ExecutionState state)
           
 WorkItem getWorkItem()
           
 WorkItem[] getWorkItems()
           
 WorkList getWorkList()
           
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 openPage(java.lang.String title, int size)
           
static java.lang.String persistentOidOf(PersistentList list)
          Deprecated. This method will be removed with MQWF V3.3 where PersistentList.persistentOid() can be used.
static java.lang.String replaceInString(java.lang.String buffer, java.lang.String oldString, java.lang.String newString)
           
 void setActivityInstance(ActivityInstance activity)
           
 void setActivityInstanceNotifications(WorkList workList, ActivityInstanceNotification[] items)
           
 void setAttribute(java.lang.String name, java.lang.Object value)
           
 void setContainer(ReadOnlyContainer container)
           
 void setControlConnectorInstance(ControlConnectorInstance controlConnector)
           
 void setException(ClientException xcpt)
           
 void setInstance(ProcessInstance instance)
           
 void setInstances(ProcessInstanceList instanceList, ProcessInstance[] instances)
           
 void setItem(Item item)
           
 void setProcessInstanceNotifications(WorkList workList, ProcessInstanceNotification[] items)
           
 void setTemplate(ProcessTemplate template)
           
 void setTemplates(ProcessTemplateList templateList, ProcessTemplate[] templates)
           
 void setWorkItem(WorkItem workItem)
           
 void setWorkItems(WorkList workList, WorkItem[] workItems)
           
static java.lang.String toHTMLText(java.lang.String value)
          Quotes characters that have a special meaning in HTML.
static java.lang.String toJavaScriptString(java.lang.String value, char quote)
           
 java.lang.String toString(AssignReason r)
           
 java.lang.String toString(ItemType t)
           
 java.lang.String toString(Type t)
           
 java.lang.String toString(Type t)
           
 

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)
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)

getTemplateList

public ProcessTemplateList getTemplateList()

getTemplates

public ProcessTemplate[] getTemplates()

setTemplates

public void setTemplates(ProcessTemplateList templateList,
                         ProcessTemplate[] templates)

getTemplate

public ProcessTemplate getTemplate()

setTemplate

public void setTemplate(ProcessTemplate template)

getInstanceList

public ProcessInstanceList getInstanceList()

getInstances

public ProcessInstance[] getInstances()

setInstances

public void setInstances(ProcessInstanceList instanceList,
                         ProcessInstance[] instances)

getInstance

public ProcessInstance getInstance()

setInstance

public void setInstance(ProcessInstance instance)

getWorkList

public WorkList getWorkList()

getProcessInstanceNotifications

public ProcessInstanceNotification[] getProcessInstanceNotifications()

setProcessInstanceNotifications

public void setProcessInstanceNotifications(WorkList workList,
                                            ProcessInstanceNotification[] items)

getActivityInstanceNotifications

public ActivityInstanceNotification[] getActivityInstanceNotifications()

setActivityInstanceNotifications

public void setActivityInstanceNotifications(WorkList workList,
                                             ActivityInstanceNotification[] items)

getWorkItems

public WorkItem[] getWorkItems()

setWorkItems

public void setWorkItems(WorkList workList,
                         WorkItem[] workItems)

getWorkItem

public WorkItem getWorkItem()

setWorkItem

public void setWorkItem(WorkItem workItem)

getItem

public Item getItem()

setItem

public void setItem(Item item)

getContainer

public ReadOnlyContainer getContainer()

setContainer

public void setContainer(ReadOnlyContainer container)

getException

public ClientException getException()

setException

public void setException(ClientException xcpt)

getActivityInstance

public ActivityInstance getActivityInstance()

setActivityInstance

public void setActivityInstance(ActivityInstance activity)

getControlConnectorInstance

public ControlConnectorInstance getControlConnectorInstance()

setControlConnectorInstance

public void setControlConnectorInstance(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.

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)

generateForm

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

replaceInString

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

persistentOidOf

public static java.lang.String persistentOidOf(PersistentList list)
Deprecated. This method will be removed with MQWF V3.3 where PersistentList.persistentOid() can be used.

Query the OID of a persistent list.
Parameters:
list - the list whose OID is needed
Returns:
the OID of the list

getMemberValue

public static java.lang.String getMemberValue(ReadOnlyContainer container,
                                              java.lang.String member,
                                              java.lang.String notSet)
                                       throws FmcException

getMemberValue

public static java.lang.String getMemberValue(ContainerElement member,
                                              java.lang.String notSet)
                                       throws FmcException

toString

public java.lang.String toString(ItemType t)

getImageForItem

public static java.lang.String getImageForItem(ItemType t)

toString

public java.lang.String toString(Type t)

toString

public java.lang.String toString(Type t)

toString

public java.lang.String toString(AssignReason r)

getPIImageForState

public static java.lang.String getPIImageForState(ExecutionState state)

getWIImageForState

public static java.lang.String getWIImageForState(ExecutionState state)

getWIStringForState

public java.lang.String getWIStringForState(ExecutionState state)

getRealWIStringForState

public static java.lang.String getRealWIStringForState(ExecutionState state)

getAIStringForState

public java.lang.String getAIStringForState(ExecutionState state)

getAIImageForState

public static java.lang.String getAIImageForState(ExecutionState state)

getCIStringForState

public java.lang.String getCIStringForState(EvaluationState state)

getPIStringForState

public java.lang.String getPIStringForState(ExecutionState state)

getRealPIStringForState

public static java.lang.String getRealPIStringForState(ExecutionState state)

getStringForAuditMode

public java.lang.String getStringForAuditMode(AuditSetting audit)

formatStringArray

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


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