com.ibm.workflow.portlet.client
Interface ApplicationContext

All Known Subinterfaces:
SessionContext
All Known Implementing Classes:
ApplicationContextProxy

public interface ApplicationContext


Method Summary
 java.lang.String formatDate(java.util.Date date)
           
 java.lang.String formatTime(java.util.Date date)
           
 com.ibm.workflow.api.Agent getAgent()
          Query the Web Client's agent.
 BuiltinHandler getBuiltinHandler()
          This method allows to access the builtin command handler.
 Config getConfig()
          This method allows to access the Web Client's configuration.
 java.lang.String getDocumentRoot()
          Query the Web Client's document root directory.
 java.lang.String getJavaApiVersionInfo()
           
 java.lang.String getRealPath(java.lang.String file)
           
 java.lang.String getRootURI()
          Query the Web Client's root URI.
 java.lang.String getServerInfo()
           
 java.lang.String getServletVersion()
           
 java.lang.String getTriggerTagFor(int list, RequestContext context)
           
 java.lang.String getURL(java.lang.String file)
          Convert a URL relative to the servlet's root URI.
 boolean isDebugEnabled()
           
 void log(java.lang.String logEntry, boolean log)
           
 void log(java.lang.String logEntry, java.lang.Throwable xcpt)
           
 

Method Detail

getServerInfo

public java.lang.String getServerInfo()

getServletVersion

public java.lang.String getServletVersion()

getJavaApiVersionInfo

public java.lang.String getJavaApiVersionInfo()

getTriggerTagFor

public java.lang.String getTriggerTagFor(int list,
                                         RequestContext context)
                                  throws com.ibm.workflow.api.FmcException

getConfig

public Config getConfig()
This method allows to access the Web Client's configuration.
Returns:
The configuration

getBuiltinHandler

public BuiltinHandler getBuiltinHandler()
This method allows to access the builtin command handler.
Returns:
The builtin command handler

log

public void log(java.lang.String logEntry,
                java.lang.Throwable xcpt)

log

public void log(java.lang.String logEntry,
                boolean log)

getURL

public java.lang.String getURL(java.lang.String file)
Convert a URL relative to the servlet's root URI. to an absolute URL. For example,
context.getURL("{_HTMLDir_}/images/myImage.gif");
might result in
/MQWFClient/images/myImage.gif
Parameters:
file - A relative URL.
Returns:
An absolute URL.

getRootURI

public java.lang.String getRootURI()
Query the Web Client's root URI.
Returns:
The root URI.

getDocumentRoot

public java.lang.String getDocumentRoot()
Query the Web Client's document root directory.
Returns:
The document root directory.

getRealPath

public java.lang.String getRealPath(java.lang.String file)

formatDate

public java.lang.String formatDate(java.util.Date date)

formatTime

public java.lang.String formatTime(java.util.Date date)

getAgent

public com.ibm.workflow.api.Agent getAgent()
                                    throws java.beans.PropertyVetoException
Query the Web Client's agent. This agent can be used to locate ExecutionService objects and to log on.
Parameters:
context - the request context
Returns:
The Agent object.
Throws:
java.beans.PropertyVetoException - if an error occured.

isDebugEnabled

public boolean isDebugEnabled()


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