com.ibm.workflow.portlet.client
Class SessionContextProxy

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

public class SessionContextProxy
extends ApplicationContextProxy
implements SessionContext


Inner classes inherited from class com.ibm.workflow.portlet.client.SessionContext
SessionContext.MonitorPackage
 
Fields inherited from interface com.ibm.workflow.portlet.client.SessionContext
ACTIVITYINSTANCELIST, INSTANCELIST, LISTS, NOT_SET, SESSION_KEY, TEMPLATELIST, WORKLIST
 
Method Summary
 java.lang.String get(java.lang.String key)
          Query a message without substitution variables.
 java.lang.String get(java.lang.String key, java.lang.String subst)
          Query a message with one substitution variable.
 java.lang.String get(java.lang.String key, java.lang.String[] subst)
          Query a message with multiple substitution variables.
 com.ibm.workflow.api.ActivityInstance getActivityInstance(java.lang.String oid)
           
 com.ibm.workflow.api.ActivityInstanceList getActivityInstanceList(java.lang.String oidOfList)
           
 java.lang.String getActivityInstanceListOid()
           
 java.util.Enumeration getActivityInstanceLists()
           
 com.ibm.workflow.api.ActivityInstanceNotification getActivityInstanceNotification(java.lang.String oidOfList, java.lang.String itemOid)
           
 com.ibm.workflow.api.ActivityInstanceNotification[] getActivityInstanceNotifications(java.lang.String oidOfList)
           
 com.ibm.workflow.api.ActivityInstance[] getActivityInstances(java.lang.String oidOfList)
           
 com.ibm.workflow.api.ActivityInstanceList getActivityList(java.lang.String activityListOid)
           
 java.lang.String getCommand(java.lang.String command)
          Constructs a request URI for the Web Client's servlet using the given command.
 java.lang.String getCommand(java.lang.String command, java.lang.String id)
          Constructs a request URI for the Web Client's servlet using the given command and OID.
 java.lang.String getCommand(java.lang.String command, java.lang.String id, java.lang.String addl)
          Constructs a request URI for the Web Client's servlet using the given command and OID.
 com.ibm.workflow.api.ControlConnectorInstance getControlConnectorInstance(java.lang.String sourceOid, java.lang.String targetOid)
           
 com.ibm.workflow.api.ExecutionService getExecutionService()
           
 com.ibm.workflow.api.ProcessInstance getInstance(java.lang.String oidOfList, java.lang.String instanceOid)
           
 com.ibm.workflow.api.ProcessInstanceList getInstanceList(java.lang.String oidOfList)
           
 java.lang.String getInstanceListOid()
           
 java.util.Enumeration getInstanceLists()
           
 com.ibm.workflow.api.ProcessInstance[] getInstances(java.lang.String oidOfList)
           
 int getKindOfList()
           
 int getKindOfSelectedList()
           
 java.util.Locale getLocale()
           
 ProcessMonitor getMonitor(javax.servlet.http.HttpSession session, java.lang.String id)
           
 SessionContext.MonitorPackage getMonitor(int index)
           
 int getMonitorListSize()
           
 java.lang.String getMonitorName(java.lang.String leafName)
           
 int getNumberOfActivityInstanceLists()
           
 int getNumberOfInstanceLists()
           
 int getNumberOfTemplateLists()
           
 int getNumberOfWorkLists()
           
 java.lang.String getOidOfMonitor(java.lang.String oid)
           
 java.lang.String getPortletCommand(org.apache.jetspeed.portlet.PortletResponse response, java.lang.String action, java.lang.String command)
           
 java.lang.String getPortletCommand(org.apache.jetspeed.portlet.PortletResponse response, java.lang.String action, java.lang.String command, java.lang.String id)
           
 java.lang.String getPortletCommand(org.apache.jetspeed.portlet.PortletResponse response, java.lang.String action, java.lang.String command, java.lang.String id, java.lang.String addl)
           
 com.ibm.workflow.api.ProcessInstanceNotification getProcessInstanceNotification(java.lang.String oidOfList, java.lang.String itemOid)
           
 com.ibm.workflow.api.ProcessInstanceNotification[] getProcessInstanceNotifications(java.lang.String oidOfList)
           
 com.ibm.workflow.api.PersistentList getSelectedList()
           
 java.lang.String getServletName()
          Query the Web Client's servlet name.
 java.lang.String getServletPath()
           
 java.lang.String getSystemGroup()
          Query the system group name of the workflow user owning this session.
 com.ibm.workflow.api.ProcessTemplate getTemplate(java.lang.String oidOfList, java.lang.String templateOid)
           
 com.ibm.workflow.api.ProcessTemplateList getTemplateList(java.lang.String oidOfList)
           
 java.lang.String getTemplateListOid()
           
 java.util.Enumeration getTemplateLists()
           
 com.ibm.workflow.api.ProcessTemplate[] getTemplates(java.lang.String oidOfList)
           
 int getTimezoneOffset()
          Return the offset between the client time zone and the server time zone.
 java.lang.String getUserID()
          Query the ID of the workflow user who owns this session.
 Viewer getViewer()
           
 com.ibm.workflow.api.WorkItem getWorkItem(java.lang.String oidOfList, java.lang.String itemOid)
           
 com.ibm.workflow.api.WorkItem[] getWorkItems(java.lang.String oidOfList)
           
 com.ibm.workflow.api.WorkList getWorkList(java.lang.String oidOfList)
           
 java.lang.String getWorkListOid()
           
 java.util.Enumeration getWorkLists()
           
 boolean loggedOnAs(java.lang.String userID, java.lang.String group, java.lang.String system)
           
 void removeAllMonitorsUpto(java.lang.String oid, boolean deleteTheOne)
           
 void setActivityInstanceListOid(java.lang.String oidOfList)
           
 void setInstanceListOid(java.lang.String instanceListOid)
           
 void setKindOfList(int kindOfList)
           
 void setKindOfSelectedList(int kindOfSelectedList)
           
 void setLocale(javax.servlet.http.HttpServletResponse response)
          Sets the appropriate locale and content type.
 void setLocale(java.util.Locale locale)
           
 void setSelectedList(com.ibm.workflow.api.PersistentList list)
           
 void setTemplateListOid(java.lang.String templateListOid)
           
 void setViewer(Viewer viewer)
           
 void setWorkListOid(java.lang.String workListOid)
           
 java.lang.String toString(java.util.Calendar cal)
          Formats a server date according to the DateFormat and TimeFormat settings in PortalClient.properties.
 
Methods inherited from class com.ibm.workflow.portlet.client.ApplicationContextProxy
formatDate, formatTime, getAgent, getBuiltinHandler, getConfig, getDocumentRoot, getJavaApiVersionInfo, getRealPath, getRootURI, getServerInfo, getServletVersion, getTriggerTagFor, getURL, isDebugEnabled, log, log
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.workflow.portlet.client.ApplicationContext
formatDate, formatTime, getAgent, getBuiltinHandler, getConfig, getDocumentRoot, getJavaApiVersionInfo, getRealPath, getRootURI, getServerInfo, getServletVersion, getTriggerTagFor, getURL, isDebugEnabled, log, log
 

Method Detail

get

public final java.lang.String get(java.lang.String key)
Description copied from interface: Catalog
Query a message without substitution variables.
Specified by:
get in interface Catalog
Following copied from interface: com.ibm.workflow.portlet.client.Catalog
Parameters:
key - The message ID
Returns:
the message or null if it could not be found

get

public final java.lang.String get(java.lang.String key,
                                  java.lang.String subst)
Description copied from interface: Catalog
Query a message with one substitution variable.
Specified by:
get in interface Catalog
Following copied from interface: com.ibm.workflow.portlet.client.Catalog
Parameters:
key - The message ID
subst - The variable
Returns:
the message or null if it could not be found

get

public final java.lang.String get(java.lang.String key,
                                  java.lang.String[] subst)
Description copied from interface: Catalog
Query a message with multiple substitution variables.
Specified by:
get in interface Catalog
Following copied from interface: com.ibm.workflow.portlet.client.Catalog
Parameters:
key - The message ID
subst - An array of variables
Returns:
the message or null if it could not be found

setLocale

public void setLocale(java.util.Locale locale)
Specified by:
setLocale in interface SessionContext

getLocale

public java.util.Locale getLocale()
Specified by:
getLocale in interface SessionContext

setLocale

public void setLocale(javax.servlet.http.HttpServletResponse response)
Description copied from interface: SessionContext
Sets the appropriate locale and content type. This will change the 'Language' and 'Content-Type' HTTP headers according to the client locale (see SessionContext.getLocale()). The content type will be text/html including the appropriate charset parameter.
Specified by:
setLocale in interface SessionContext
Following copied from interface: com.ibm.workflow.portlet.client.SessionContext
Parameters:
response - the HTTP response object

getServletName

public final java.lang.String getServletName()
Description copied from interface: SessionContext
Query the Web Client's servlet name. This is the name specified when configuring the servlet in your Web Server's servlet container. Always use this string instead of a hard-coded servlet name.
Specified by:
getServletName in interface SessionContext
Following copied from interface: com.ibm.workflow.portlet.client.SessionContext
Returns:
The name of the servlet.

getServletPath

public final java.lang.String getServletPath()
Specified by:
getServletPath in interface SessionContext

toString

public java.lang.String toString(java.util.Calendar cal)
Description copied from interface: SessionContext
Formats a server date according to the DateFormat and TimeFormat settings in PortalClient.properties. If the client timezone offset is set, the parameter will be converted to client time first.
Specified by:
toString in interface SessionContext
Following copied from interface: com.ibm.workflow.portlet.client.SessionContext
Parameters:
cal - the time to be formatted
Returns:
the formatted string

getTimezoneOffset

public int getTimezoneOffset()
Description copied from interface: SessionContext
Return the offset between the client time zone and the server time zone. This is the number of minutes that must be added to the client time to get the server time. This offset is initialized through the timezoneOffset parameter of BuiltinHandler.logon().
Specified by:
getTimezoneOffset in interface SessionContext
Following copied from interface: com.ibm.workflow.portlet.client.SessionContext
Returns:
the time zone offset in minutes

loggedOnAs

public final boolean loggedOnAs(java.lang.String userID,
                                java.lang.String group,
                                java.lang.String system)
Specified by:
loggedOnAs in interface SessionContext

setViewer

public final void setViewer(Viewer viewer)
Specified by:
setViewer in interface SessionContext

getViewer

public final Viewer getViewer()
Specified by:
getViewer in interface SessionContext

getExecutionService

public final com.ibm.workflow.api.ExecutionService getExecutionService()
Specified by:
getExecutionService in interface SessionContext

getUserID

public final java.lang.String getUserID()
Description copied from interface: SessionContext
Query the ID of the workflow user who owns this session.
Specified by:
getUserID in interface SessionContext
Following copied from interface: com.ibm.workflow.portlet.client.SessionContext
Returns:
the user ID of the session owner.

getSystemGroup

public final java.lang.String getSystemGroup()
Description copied from interface: SessionContext
Query the system group name of the workflow user owning this session.
Specified by:
getSystemGroup in interface SessionContext
Following copied from interface: com.ibm.workflow.portlet.client.SessionContext
Returns:
the system group name of the session owner.

getCommand

public java.lang.String getCommand(java.lang.String command)
Description copied from interface: SessionContext
Constructs a request URI for the Web Client's servlet using the given command.
Specified by:
getCommand in interface SessionContext
Following copied from interface: com.ibm.workflow.portlet.client.SessionContext
Parameters:
command - the name of the servlet command
Returns:
a String to invoke the servlet command that was passed as parameter

getCommand

public java.lang.String getCommand(java.lang.String command,
                                   java.lang.String id)
Description copied from interface: SessionContext
Constructs a request URI for the Web Client's servlet using the given command and OID.
Specified by:
getCommand in interface SessionContext
Following copied from interface: com.ibm.workflow.portlet.client.SessionContext
Parameters:
command - the name of the servlet command
id - the OID of the object for which to invoke the command
Returns:
a String to invoke the servlet command that was passed as parameter

getCommand

public java.lang.String getCommand(java.lang.String command,
                                   java.lang.String id,
                                   java.lang.String addl)
Description copied from interface: SessionContext
Constructs a request URI for the Web Client's servlet using the given command and OID.
Specified by:
getCommand in interface SessionContext
Following copied from interface: com.ibm.workflow.portlet.client.SessionContext
Parameters:
command - the name of the servlet command
id - the OID of the object for which to invoke the command
addl - additional parameters for the command. Must start with & and must be URL-encoded (see java.net.URLEncoder.encode()).
Returns:
a String to invoke the servlet command that was passed as parameter

getPortletCommand

public java.lang.String getPortletCommand(org.apache.jetspeed.portlet.PortletResponse response,
                                          java.lang.String action,
                                          java.lang.String command)

getPortletCommand

public java.lang.String getPortletCommand(org.apache.jetspeed.portlet.PortletResponse response,
                                          java.lang.String action,
                                          java.lang.String command,
                                          java.lang.String id)

getPortletCommand

public java.lang.String getPortletCommand(org.apache.jetspeed.portlet.PortletResponse response,
                                          java.lang.String action,
                                          java.lang.String command,
                                          java.lang.String id,
                                          java.lang.String addl)

getTemplateLists

public final java.util.Enumeration getTemplateLists()
Specified by:
getTemplateLists in interface SessionContext

getNumberOfTemplateLists

public final int getNumberOfTemplateLists()
Specified by:
getNumberOfTemplateLists in interface SessionContext

getTemplateListOid

public java.lang.String getTemplateListOid()
Specified by:
getTemplateListOid in interface SessionContext

setTemplateListOid

public void setTemplateListOid(java.lang.String templateListOid)
Specified by:
setTemplateListOid in interface SessionContext

getTemplateList

public final com.ibm.workflow.api.ProcessTemplateList getTemplateList(java.lang.String oidOfList)
Specified by:
getTemplateList in interface SessionContext

getTemplates

public final com.ibm.workflow.api.ProcessTemplate[] getTemplates(java.lang.String oidOfList)
Specified by:
getTemplates in interface SessionContext

getActivityInstances

public final com.ibm.workflow.api.ActivityInstance[] getActivityInstances(java.lang.String oidOfList)
Specified by:
getActivityInstances in interface SessionContext

setActivityInstanceListOid

public final void setActivityInstanceListOid(java.lang.String oidOfList)

getActivityInstanceListOid

public final java.lang.String getActivityInstanceListOid()
Specified by:
getActivityInstanceListOid in interface SessionContext

getTemplate

public com.ibm.workflow.api.ProcessTemplate getTemplate(java.lang.String oidOfList,
                                                        java.lang.String templateOid)
Specified by:
getTemplate in interface SessionContext

getInstanceLists

public final java.util.Enumeration getInstanceLists()
Specified by:
getInstanceLists in interface SessionContext

getNumberOfInstanceLists

public final int getNumberOfInstanceLists()
Specified by:
getNumberOfInstanceLists in interface SessionContext

getInstanceListOid

public java.lang.String getInstanceListOid()
Specified by:
getInstanceListOid in interface SessionContext

setInstanceListOid

public void setInstanceListOid(java.lang.String instanceListOid)
Specified by:
setInstanceListOid in interface SessionContext

getInstanceList

public final com.ibm.workflow.api.ProcessInstanceList getInstanceList(java.lang.String oidOfList)
Specified by:
getInstanceList in interface SessionContext

getInstances

public final com.ibm.workflow.api.ProcessInstance[] getInstances(java.lang.String oidOfList)
Specified by:
getInstances in interface SessionContext

getInstance

public final com.ibm.workflow.api.ProcessInstance getInstance(java.lang.String oidOfList,
                                                              java.lang.String instanceOid)
Specified by:
getInstance in interface SessionContext

getWorkLists

public final java.util.Enumeration getWorkLists()
Specified by:
getWorkLists in interface SessionContext

getNumberOfWorkLists

public final int getNumberOfWorkLists()
Specified by:
getNumberOfWorkLists in interface SessionContext

getNumberOfActivityInstanceLists

public int getNumberOfActivityInstanceLists()
Specified by:
getNumberOfActivityInstanceLists in interface SessionContext

getWorkListOid

public java.lang.String getWorkListOid()
Specified by:
getWorkListOid in interface SessionContext

setWorkListOid

public void setWorkListOid(java.lang.String workListOid)
Specified by:
setWorkListOid in interface SessionContext

getWorkList

public final com.ibm.workflow.api.WorkList getWorkList(java.lang.String oidOfList)
Specified by:
getWorkList in interface SessionContext

getWorkItems

public final com.ibm.workflow.api.WorkItem[] getWorkItems(java.lang.String oidOfList)
Specified by:
getWorkItems in interface SessionContext

getActivityList

public com.ibm.workflow.api.ActivityInstanceList getActivityList(java.lang.String activityListOid)
Specified by:
getActivityList in interface SessionContext

getWorkItem

public final com.ibm.workflow.api.WorkItem getWorkItem(java.lang.String oidOfList,
                                                       java.lang.String itemOid)
Specified by:
getWorkItem in interface SessionContext

getProcessInstanceNotifications

public final com.ibm.workflow.api.ProcessInstanceNotification[] getProcessInstanceNotifications(java.lang.String oidOfList)
Specified by:
getProcessInstanceNotifications in interface SessionContext

getProcessInstanceNotification

public final com.ibm.workflow.api.ProcessInstanceNotification getProcessInstanceNotification(java.lang.String oidOfList,
                                                                                             java.lang.String itemOid)
Specified by:
getProcessInstanceNotification in interface SessionContext

getActivityInstanceLists

public final java.util.Enumeration getActivityInstanceLists()

getActivityInstanceList

public com.ibm.workflow.api.ActivityInstanceList getActivityInstanceList(java.lang.String oidOfList)
Specified by:
getActivityInstanceList in interface SessionContext

getActivityInstanceNotifications

public final com.ibm.workflow.api.ActivityInstanceNotification[] getActivityInstanceNotifications(java.lang.String oidOfList)
Specified by:
getActivityInstanceNotifications in interface SessionContext

getActivityInstanceNotification

public final com.ibm.workflow.api.ActivityInstanceNotification getActivityInstanceNotification(java.lang.String oidOfList,
                                                                                               java.lang.String itemOid)
Specified by:
getActivityInstanceNotification in interface SessionContext

getMonitor

public final SessionContext.MonitorPackage getMonitor(int index)
Specified by:
getMonitor in interface SessionContext

getMonitorListSize

public final int getMonitorListSize()
Specified by:
getMonitorListSize in interface SessionContext

removeAllMonitorsUpto

public void removeAllMonitorsUpto(java.lang.String oid,
                                  boolean deleteTheOne)
Specified by:
removeAllMonitorsUpto in interface SessionContext

getKindOfList

public int getKindOfList()
Specified by:
getKindOfList in interface SessionContext

setKindOfList

public void setKindOfList(int kindOfList)
Specified by:
setKindOfList in interface SessionContext

getSelectedList

public com.ibm.workflow.api.PersistentList getSelectedList()
Specified by:
getSelectedList in interface SessionContext

setSelectedList

public void setSelectedList(com.ibm.workflow.api.PersistentList list)
Specified by:
setSelectedList in interface SessionContext

getKindOfSelectedList

public int getKindOfSelectedList()
Specified by:
getKindOfSelectedList in interface SessionContext

setKindOfSelectedList

public void setKindOfSelectedList(int kindOfSelectedList)
Specified by:
setKindOfSelectedList in interface SessionContext

getOidOfMonitor

public final java.lang.String getOidOfMonitor(java.lang.String oid)
                                       throws com.ibm.workflow.api.FmcException
Specified by:
getOidOfMonitor in interface SessionContext

getMonitorName

public java.lang.String getMonitorName(java.lang.String leafName)
Specified by:
getMonitorName in interface SessionContext

getActivityInstance

public final com.ibm.workflow.api.ActivityInstance getActivityInstance(java.lang.String oid)
                                                                throws com.ibm.workflow.api.FmcException
Specified by:
getActivityInstance in interface SessionContext

getMonitor

public ProcessMonitor getMonitor(javax.servlet.http.HttpSession session,
                                 java.lang.String id)
Specified by:
getMonitor in interface SessionContext

getControlConnectorInstance

public final com.ibm.workflow.api.ControlConnectorInstance getControlConnectorInstance(java.lang.String sourceOid,
                                                                                       java.lang.String targetOid)
                                                                                throws com.ibm.workflow.api.FmcException
Specified by:
getControlConnectorInstance in interface SessionContext


© Copyright IBM Corporation 2002, 2007. All Rights Reserved.