com.ibm.workflow.servlet.client
Interface SessionContext

All Known Implementing Classes:
RequestContext

public interface SessionContext
extends Catalog, ApplicationContext


Inner Class Summary
static class SessionContext.MonitorPackage
           
 
Field Summary
static int INSTANCELIST
           
static int LISTS
           
static int NOT_SET
           
static java.lang.String SESSION_KEY
           
static int TEMPLATELIST
           
static int WORKLIST
           
 
Method Summary
 java.lang.String addInstanceList(ProcessInstanceList list)
           
 java.lang.String addTemplateList(ProcessTemplateList list)
           
 java.lang.String addWorkList(WorkList list)
           
 ActivityInstance getActivityInstance(java.lang.String Oid)
           
 ActivityInstanceNotification getActivityInstanceNotification(java.lang.String oidOfList, java.lang.String itemOid)
           
 ActivityInstanceNotification[] getActivityInstanceNotifications(java.lang.String oidOfList)
           
 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.
 ControlConnectorInstance getControlConnectorInstance(java.lang.String sourceOid, java.lang.String targetOid)
           
 ExecutionService getExecutionService()
           
 ProcessInstance getInstance(java.lang.String oidOfList, java.lang.String instanceOid)
           
 ProcessInstanceList getInstanceList(java.lang.String oidOfList)
           
 java.lang.String getInstanceListOid()
           
 java.util.Enumeration getInstanceLists()
           
 ProcessInstance[] getInstances(java.lang.String oidOfList)
           
 int getKindOfList()
           
 int getKindOfSelectedList()
           
 java.util.Locale getLocale()
           
 SessionContext.MonitorPackage getMonitor(int index)
           
 int getMonitorListSize()
           
 java.lang.String getMonitorName(java.lang.String leafName)
           
 int getNumberOfInstanceLists()
           
 int getNumberOfTemplateLists()
           
 int getNumberOfWorkLists()
           
 java.lang.String getOidOfMonitor(java.lang.String Oid)
           
 ProcessInstanceNotification getProcessInstanceNotification(java.lang.String oidOfList, java.lang.String itemOid)
           
 ProcessInstanceNotification[] getProcessInstanceNotifications(java.lang.String oidOfList)
           
 PersistentList getSelectedList()
           
 java.lang.String getSystemGroup()
          Query the system group name of the workflow user owning this session.
 ProcessTemplate getTemplate(java.lang.String oidOfList, java.lang.String templateOid)
           
 ProcessTemplateList getTemplateList(java.lang.String oidOfList)
           
 java.lang.String getTemplateListOid()
           
 java.util.Enumeration getTemplateLists()
           
 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()
           
 WorkItem getWorkItem(java.lang.String oidOfList, java.lang.String itemOid)
           
 WorkItem[] getWorkItems(java.lang.String oidOfList)
           
 WorkList getWorkList(java.lang.String oidOfList)
           
 java.lang.String getWorkListOid()
           
 java.util.Enumeration getWorkLists()
           
 java.lang.StringBuffer loadTemplateFile(java.lang.String urlname, java.util.Properties vars)
           
 boolean loggedOnAs(java.lang.String userID, java.lang.String group, java.lang.String system)
           
 void removeAllMonitorsUpto(java.lang.String oid, boolean deleteTheOne)
           
 void setInstanceListOid(java.lang.String instanceListOid)
           
 void setKindOfList(int kindOfList)
           
 void setKindOfSelectedList(int kindOfSelectedList)
           
 void setLocale(java.util.Locale locale)
           
 void setSelectedList(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 WebClient.properties.
 
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, getBuiltinHandler, getConfig, getDocBase, getDocumentRoot, getHTMLDir, getJavaApiVersionInfo, getRealPath, getRootURI, getServerInfo, getServletName, getServletPath, getServletVersion, getTriggerTagFor, getURL, log, log
 

Field Detail

NOT_SET

public static final int NOT_SET

WORKLIST

public static final int WORKLIST

INSTANCELIST

public static final int INSTANCELIST

TEMPLATELIST

public static final int TEMPLATELIST

LISTS

public static final int LISTS

SESSION_KEY

public static final java.lang.String SESSION_KEY
Method Detail

setLocale

public void setLocale(java.util.Locale locale)

getLocale

public java.util.Locale getLocale()

toString

public java.lang.String toString(java.util.Calendar cal)
Formats a server date according to the DateFormat and TimeFormat settings in WebClient.properties. If the client timezone offset is set, the parameter will be converted to client time first.
Parameters:
cal - the time to be formatted
Returns:
the formatted string

getTimezoneOffset

public int getTimezoneOffset()
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().
Returns:
the time zone offset in minutes

loggedOnAs

public boolean loggedOnAs(java.lang.String userID,
                          java.lang.String group,
                          java.lang.String system)

setViewer

public void setViewer(Viewer viewer)

getViewer

public Viewer getViewer()

getExecutionService

public ExecutionService getExecutionService()

getUserID

public java.lang.String getUserID()
Query the ID of the workflow user who owns this session.
Returns:
the user ID of the session owner.

getSystemGroup

public java.lang.String getSystemGroup()
Query the system group name of the workflow user owning this session.
Returns:
the system group name of the session owner.

getCommand

public java.lang.String getCommand(java.lang.String command)
Constructs a request URI for the Web Client's servlet using the given command.
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)
Constructs a request URI for the Web Client's servlet using the given command and OID.
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)
Constructs a request URI for the Web Client's servlet using the given command and OID.
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

loadTemplateFile

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

getTemplateLists

public java.util.Enumeration getTemplateLists()

getNumberOfTemplateLists

public int getNumberOfTemplateLists()

addTemplateList

public java.lang.String addTemplateList(ProcessTemplateList list)

getTemplateListOid

public java.lang.String getTemplateListOid()

setTemplateListOid

public void setTemplateListOid(java.lang.String templateListOid)

getTemplateList

public ProcessTemplateList getTemplateList(java.lang.String oidOfList)

getTemplates

public ProcessTemplate[] getTemplates(java.lang.String oidOfList)

getTemplate

public ProcessTemplate getTemplate(java.lang.String oidOfList,
                                   java.lang.String templateOid)

getInstanceLists

public java.util.Enumeration getInstanceLists()

getNumberOfInstanceLists

public int getNumberOfInstanceLists()

addInstanceList

public java.lang.String addInstanceList(ProcessInstanceList list)

getInstanceListOid

public java.lang.String getInstanceListOid()

setInstanceListOid

public void setInstanceListOid(java.lang.String instanceListOid)

getInstanceList

public ProcessInstanceList getInstanceList(java.lang.String oidOfList)

getInstances

public ProcessInstance[] getInstances(java.lang.String oidOfList)

getInstance

public ProcessInstance getInstance(java.lang.String oidOfList,
                                   java.lang.String instanceOid)

getWorkLists

public java.util.Enumeration getWorkLists()

getNumberOfWorkLists

public int getNumberOfWorkLists()

addWorkList

public java.lang.String addWorkList(WorkList list)

getWorkListOid

public java.lang.String getWorkListOid()

setWorkListOid

public void setWorkListOid(java.lang.String workListOid)

getWorkList

public WorkList getWorkList(java.lang.String oidOfList)

getWorkItems

public WorkItem[] getWorkItems(java.lang.String oidOfList)

getWorkItem

public WorkItem getWorkItem(java.lang.String oidOfList,
                            java.lang.String itemOid)

getProcessInstanceNotifications

public ProcessInstanceNotification[] getProcessInstanceNotifications(java.lang.String oidOfList)

getProcessInstanceNotification

public ProcessInstanceNotification getProcessInstanceNotification(java.lang.String oidOfList,
                                                                  java.lang.String itemOid)

getActivityInstanceNotifications

public ActivityInstanceNotification[] getActivityInstanceNotifications(java.lang.String oidOfList)

getActivityInstanceNotification

public ActivityInstanceNotification getActivityInstanceNotification(java.lang.String oidOfList,
                                                                    java.lang.String itemOid)

getMonitor

public SessionContext.MonitorPackage getMonitor(int index)

getMonitorListSize

public int getMonitorListSize()

removeAllMonitorsUpto

public void removeAllMonitorsUpto(java.lang.String oid,
                                  boolean deleteTheOne)

getKindOfList

public int getKindOfList()

setKindOfList

public void setKindOfList(int kindOfList)

getSelectedList

public PersistentList getSelectedList()

setSelectedList

public void setSelectedList(PersistentList list)

getKindOfSelectedList

public int getKindOfSelectedList()

setKindOfSelectedList

public void setKindOfSelectedList(int kindOfSelectedList)

getOidOfMonitor

public java.lang.String getOidOfMonitor(java.lang.String Oid)
                                 throws FmcException

getMonitorName

public java.lang.String getMonitorName(java.lang.String leafName)

getActivityInstance

public ActivityInstance getActivityInstance(java.lang.String Oid)
                                     throws FmcException

getControlConnectorInstance

public ControlConnectorInstance getControlConnectorInstance(java.lang.String sourceOid,
                                                            java.lang.String targetOid)
                                                     throws FmcException


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