|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.workflow.portlet.client.ApplicationContextProxy | +--com.ibm.workflow.portlet.client.SessionContextProxy
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 |
public final java.lang.String get(java.lang.String key)
Catalog
get
in interface Catalog
com.ibm.workflow.portlet.client.Catalog
key
- The message IDnull
if it could not be foundpublic final java.lang.String get(java.lang.String key, java.lang.String subst)
Catalog
get
in interface Catalog
com.ibm.workflow.portlet.client.Catalog
key
- The message IDsubst
- The variablenull
if it could not be foundpublic final java.lang.String get(java.lang.String key, java.lang.String[] subst)
Catalog
get
in interface Catalog
com.ibm.workflow.portlet.client.Catalog
key
- The message IDsubst
- An array of variablesnull
if it could not be foundpublic void setLocale(java.util.Locale locale)
setLocale
in interface SessionContext
public java.util.Locale getLocale()
getLocale
in interface SessionContext
public void setLocale(javax.servlet.http.HttpServletResponse response)
SessionContext
SessionContext.getLocale()
).
The content type will be text/html including the appropriate charset parameter.setLocale
in interface SessionContext
com.ibm.workflow.portlet.client.SessionContext
response
- the HTTP response objectpublic final java.lang.String getServletName()
SessionContext
getServletName
in interface SessionContext
com.ibm.workflow.portlet.client.SessionContext
public final java.lang.String getServletPath()
getServletPath
in interface SessionContext
public java.lang.String toString(java.util.Calendar cal)
SessionContext
DateFormat
and
TimeFormat
settings in PortalClient.properties
.
If the client timezone offset
is set, the
parameter will be converted to client time first.toString
in interface SessionContext
com.ibm.workflow.portlet.client.SessionContext
cal
- the time to be formattedpublic int getTimezoneOffset()
SessionContext
timezoneOffset
parameter of
BuiltinHandler.logon()
.getTimezoneOffset
in interface SessionContext
com.ibm.workflow.portlet.client.SessionContext
public final boolean loggedOnAs(java.lang.String userID, java.lang.String group, java.lang.String system)
loggedOnAs
in interface SessionContext
public final void setViewer(Viewer viewer)
setViewer
in interface SessionContext
public final Viewer getViewer()
getViewer
in interface SessionContext
public final com.ibm.workflow.api.ExecutionService getExecutionService()
getExecutionService
in interface SessionContext
public final java.lang.String getUserID()
SessionContext
getUserID
in interface SessionContext
com.ibm.workflow.portlet.client.SessionContext
public final java.lang.String getSystemGroup()
SessionContext
getSystemGroup
in interface SessionContext
com.ibm.workflow.portlet.client.SessionContext
public java.lang.String getCommand(java.lang.String command)
SessionContext
getCommand
in interface SessionContext
com.ibm.workflow.portlet.client.SessionContext
command
- the name of the servlet commandpublic java.lang.String getCommand(java.lang.String command, java.lang.String id)
SessionContext
getCommand
in interface SessionContext
com.ibm.workflow.portlet.client.SessionContext
command
- the name of the servlet commandid
- the OID of the object for which to invoke the commandpublic java.lang.String getCommand(java.lang.String command, java.lang.String id, java.lang.String addl)
SessionContext
getCommand
in interface SessionContext
com.ibm.workflow.portlet.client.SessionContext
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()
).public java.lang.String getPortletCommand(org.apache.jetspeed.portlet.PortletResponse response, java.lang.String action, java.lang.String command)
public java.lang.String getPortletCommand(org.apache.jetspeed.portlet.PortletResponse response, java.lang.String action, java.lang.String command, java.lang.String id)
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)
public final java.util.Enumeration getTemplateLists()
getTemplateLists
in interface SessionContext
public final int getNumberOfTemplateLists()
getNumberOfTemplateLists
in interface SessionContext
public java.lang.String getTemplateListOid()
getTemplateListOid
in interface SessionContext
public void setTemplateListOid(java.lang.String templateListOid)
setTemplateListOid
in interface SessionContext
public final com.ibm.workflow.api.ProcessTemplateList getTemplateList(java.lang.String oidOfList)
getTemplateList
in interface SessionContext
public final com.ibm.workflow.api.ProcessTemplate[] getTemplates(java.lang.String oidOfList)
getTemplates
in interface SessionContext
public final com.ibm.workflow.api.ActivityInstance[] getActivityInstances(java.lang.String oidOfList)
getActivityInstances
in interface SessionContext
public final void setActivityInstanceListOid(java.lang.String oidOfList)
public final java.lang.String getActivityInstanceListOid()
getActivityInstanceListOid
in interface SessionContext
public com.ibm.workflow.api.ProcessTemplate getTemplate(java.lang.String oidOfList, java.lang.String templateOid)
getTemplate
in interface SessionContext
public final java.util.Enumeration getInstanceLists()
getInstanceLists
in interface SessionContext
public final int getNumberOfInstanceLists()
getNumberOfInstanceLists
in interface SessionContext
public java.lang.String getInstanceListOid()
getInstanceListOid
in interface SessionContext
public void setInstanceListOid(java.lang.String instanceListOid)
setInstanceListOid
in interface SessionContext
public final com.ibm.workflow.api.ProcessInstanceList getInstanceList(java.lang.String oidOfList)
getInstanceList
in interface SessionContext
public final com.ibm.workflow.api.ProcessInstance[] getInstances(java.lang.String oidOfList)
getInstances
in interface SessionContext
public final com.ibm.workflow.api.ProcessInstance getInstance(java.lang.String oidOfList, java.lang.String instanceOid)
getInstance
in interface SessionContext
public final java.util.Enumeration getWorkLists()
getWorkLists
in interface SessionContext
public final int getNumberOfWorkLists()
getNumberOfWorkLists
in interface SessionContext
public int getNumberOfActivityInstanceLists()
getNumberOfActivityInstanceLists
in interface SessionContext
public java.lang.String getWorkListOid()
getWorkListOid
in interface SessionContext
public void setWorkListOid(java.lang.String workListOid)
setWorkListOid
in interface SessionContext
public final com.ibm.workflow.api.WorkList getWorkList(java.lang.String oidOfList)
getWorkList
in interface SessionContext
public final com.ibm.workflow.api.WorkItem[] getWorkItems(java.lang.String oidOfList)
getWorkItems
in interface SessionContext
public com.ibm.workflow.api.ActivityInstanceList getActivityList(java.lang.String activityListOid)
getActivityList
in interface SessionContext
public final com.ibm.workflow.api.WorkItem getWorkItem(java.lang.String oidOfList, java.lang.String itemOid)
getWorkItem
in interface SessionContext
public final com.ibm.workflow.api.ProcessInstanceNotification[] getProcessInstanceNotifications(java.lang.String oidOfList)
getProcessInstanceNotifications
in interface SessionContext
public final com.ibm.workflow.api.ProcessInstanceNotification getProcessInstanceNotification(java.lang.String oidOfList, java.lang.String itemOid)
getProcessInstanceNotification
in interface SessionContext
public final java.util.Enumeration getActivityInstanceLists()
public com.ibm.workflow.api.ActivityInstanceList getActivityInstanceList(java.lang.String oidOfList)
getActivityInstanceList
in interface SessionContext
public final com.ibm.workflow.api.ActivityInstanceNotification[] getActivityInstanceNotifications(java.lang.String oidOfList)
getActivityInstanceNotifications
in interface SessionContext
public final com.ibm.workflow.api.ActivityInstanceNotification getActivityInstanceNotification(java.lang.String oidOfList, java.lang.String itemOid)
getActivityInstanceNotification
in interface SessionContext
public final SessionContext.MonitorPackage getMonitor(int index)
getMonitor
in interface SessionContext
public final int getMonitorListSize()
getMonitorListSize
in interface SessionContext
public void removeAllMonitorsUpto(java.lang.String oid, boolean deleteTheOne)
removeAllMonitorsUpto
in interface SessionContext
public int getKindOfList()
getKindOfList
in interface SessionContext
public void setKindOfList(int kindOfList)
setKindOfList
in interface SessionContext
public com.ibm.workflow.api.PersistentList getSelectedList()
getSelectedList
in interface SessionContext
public void setSelectedList(com.ibm.workflow.api.PersistentList list)
setSelectedList
in interface SessionContext
public int getKindOfSelectedList()
getKindOfSelectedList
in interface SessionContext
public void setKindOfSelectedList(int kindOfSelectedList)
setKindOfSelectedList
in interface SessionContext
public final java.lang.String getOidOfMonitor(java.lang.String oid) throws com.ibm.workflow.api.FmcException
getOidOfMonitor
in interface SessionContext
public java.lang.String getMonitorName(java.lang.String leafName)
getMonitorName
in interface SessionContext
public final com.ibm.workflow.api.ActivityInstance getActivityInstance(java.lang.String oid) throws com.ibm.workflow.api.FmcException
getActivityInstance
in interface SessionContext
public ProcessMonitor getMonitor(javax.servlet.http.HttpSession session, java.lang.String id)
getMonitor
in interface SessionContext
public final com.ibm.workflow.api.ControlConnectorInstance getControlConnectorInstance(java.lang.String sourceOid, java.lang.String targetOid) throws com.ibm.workflow.api.FmcException
getControlConnectorInstance
in interface SessionContext
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |