com.ibm.workflow.servlet.client
Interface SessionContext
- All Superinterfaces:
- ApplicationContext, Catalog
- All Known Implementing Classes:
- SessionContextProxy, RequestContext
- public interface SessionContext
- extends Catalog, ApplicationContext
Method Summary |
com.ibm.workflow.api.ActivityInstance |
getActivityInstance(java.lang.String Oid)
|
com.ibm.workflow.api.ActivityInstance |
getActivityInstance(java.lang.String Oid,
java.lang.String listOID)
|
com.ibm.workflow.api.ActivityInstanceList |
getActivityInstanceList(java.lang.String oidOfList)
|
java.lang.String |
getActivityInstanceListOid()
|
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.Person |
getCurrentUser()
|
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()
|
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)
|
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 |
setCurrentUser(com.ibm.workflow.api.Person person)
|
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 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, getAgent, getBuiltinHandler, getConfig, getDocumentRoot, getJavaApiVersionInfo, getRealPath, getRootURI, getServerInfo, getServletVersion, getTriggerTagFor, getURL, isDebugEnabled, isUsingJNDI, log, log, useQueryResultSize |
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
ACTIVITYINSTANCELIST
public static final int ACTIVITYINSTANCELIST
SESSION_KEY
public static final java.lang.String SESSION_KEY
setLocale
public void setLocale(java.util.Locale locale)
getLocale
public java.util.Locale getLocale()
- Specified by:
getLocale
in interface Catalog
setLocale
public void setLocale(javax.servlet.http.HttpServletResponse response)
- Sets the appropriate locale and content type. This will change the 'Language' and
'Content-Type' HTTP headers according to the client locale (see
getLocale()
).
The content type will be text/html including the appropriate charset parameter.
- Parameters:
response
- the HTTP response object
getServletName
public java.lang.String getServletName()
- 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.
- Returns:
- The name of the servlet.
getServletPath
public java.lang.String getServletPath()
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 com.ibm.workflow.api.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 commandid
- 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 commandid
- the OID of the object for which to invoke the commandaddl
- 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
getTemplateLists
public java.util.Enumeration getTemplateLists()
getNumberOfTemplateLists
public int getNumberOfTemplateLists()
getTemplateListOid
public java.lang.String getTemplateListOid()
setTemplateListOid
public void setTemplateListOid(java.lang.String templateListOid)
getTemplateList
public com.ibm.workflow.api.ProcessTemplateList getTemplateList(java.lang.String oidOfList)
getTemplates
public com.ibm.workflow.api.ProcessTemplate[] getTemplates(java.lang.String oidOfList)
getTemplate
public com.ibm.workflow.api.ProcessTemplate getTemplate(java.lang.String oidOfList,
java.lang.String templateOid)
getInstanceLists
public java.util.Enumeration getInstanceLists()
getNumberOfInstanceLists
public int getNumberOfInstanceLists()
getInstanceListOid
public java.lang.String getInstanceListOid()
setInstanceListOid
public void setInstanceListOid(java.lang.String instanceListOid)
getInstanceList
public com.ibm.workflow.api.ProcessInstanceList getInstanceList(java.lang.String oidOfList)
getActivityInstanceList
public com.ibm.workflow.api.ActivityInstanceList getActivityInstanceList(java.lang.String oidOfList)
getInstances
public com.ibm.workflow.api.ProcessInstance[] getInstances(java.lang.String oidOfList)
getInstance
public com.ibm.workflow.api.ProcessInstance getInstance(java.lang.String oidOfList,
java.lang.String instanceOid)
getWorkLists
public java.util.Enumeration getWorkLists()
getNumberOfWorkLists
public int getNumberOfWorkLists()
getWorkListOid
public java.lang.String getWorkListOid()
setWorkListOid
public void setWorkListOid(java.lang.String workListOid)
getWorkList
public com.ibm.workflow.api.WorkList getWorkList(java.lang.String oidOfList)
getActivityList
public com.ibm.workflow.api.ActivityInstanceList getActivityList(java.lang.String activityListOid)
getNumberOfActivityInstanceLists
public int getNumberOfActivityInstanceLists()
getWorkItems
public com.ibm.workflow.api.WorkItem[] getWorkItems(java.lang.String oidOfList)
getActivityInstances
public com.ibm.workflow.api.ActivityInstance[] getActivityInstances(java.lang.String oidOfList)
getActivityInstanceListOid
public java.lang.String getActivityInstanceListOid()
getWorkItem
public com.ibm.workflow.api.WorkItem getWorkItem(java.lang.String oidOfList,
java.lang.String itemOid)
getProcessInstanceNotifications
public com.ibm.workflow.api.ProcessInstanceNotification[] getProcessInstanceNotifications(java.lang.String oidOfList)
getProcessInstanceNotification
public com.ibm.workflow.api.ProcessInstanceNotification getProcessInstanceNotification(java.lang.String oidOfList,
java.lang.String itemOid)
getActivityInstanceNotifications
public com.ibm.workflow.api.ActivityInstanceNotification[] getActivityInstanceNotifications(java.lang.String oidOfList)
getActivityInstanceNotification
public com.ibm.workflow.api.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 com.ibm.workflow.api.PersistentList getSelectedList()
setSelectedList
public void setSelectedList(com.ibm.workflow.api.PersistentList list)
getKindOfSelectedList
public int getKindOfSelectedList()
setKindOfSelectedList
public void setKindOfSelectedList(int kindOfSelectedList)
getOidOfMonitor
public java.lang.String getOidOfMonitor(java.lang.String Oid)
throws com.ibm.workflow.api.FmcException
getMonitorName
public java.lang.String getMonitorName(java.lang.String leafName)
getActivityInstance
public com.ibm.workflow.api.ActivityInstance getActivityInstance(java.lang.String Oid)
throws com.ibm.workflow.api.FmcException
getActivityInstance
public com.ibm.workflow.api.ActivityInstance getActivityInstance(java.lang.String Oid,
java.lang.String listOID)
getControlConnectorInstance
public com.ibm.workflow.api.ControlConnectorInstance getControlConnectorInstance(java.lang.String sourceOid,
java.lang.String targetOid)
throws com.ibm.workflow.api.FmcException
getCurrentUser
public com.ibm.workflow.api.Person getCurrentUser()
throws com.ibm.workflow.api.FmcException
setCurrentUser
public void setCurrentUser(com.ibm.workflow.api.Person person)
throws com.ibm.workflow.api.FmcException
© Copyright IBM Corporation 1999, 2008. All Rights Reserved.