com.filenet.wcm.apps.server.util.integration
Class CommandCall

java.lang.Object
  extended bycom.filenet.wcm.apps.server.util.integration.CommandCall

public class CommandCall
extends java.lang.Object


Field Summary
protected  int id
           
protected  java.lang.String name
           
protected  java.lang.String version
           
 
Constructor Summary
CommandCall()
           
CommandCall(org.w3c.dom.Document commandCall)
          Constructor for thick client XML based command call.
CommandCall(javax.servlet.http.HttpServletRequest request)
          Constructor for web based request based command call.
CommandCall(com.filenet.wcm.toolkit.server.base.WcmController controller, javax.servlet.http.HttpServletRequest request)
          Constructor for web based request based command call.
 
Method Summary
 java.lang.String getAutoConfirm()
           
 ClientRequestInfo getClientRequestInfo()
           
 com.filenet.wcm.toolkit.server.util.WcmRequestMap getCommandRequestMap()
          Get the parameters map with all of the integration servlet standard parameters filtered out.
 java.lang.String getCustomCss()
           
 java.lang.String getDismissLabel(java.util.Locale locale)
           
 java.lang.String getDismissUrl()
           
 int getId()
           
 java.lang.String getLaunchedWindowId()
           
 java.lang.String getName()
           
 java.util.Map getParameters()
           
 java.lang.String getQueryString()
          Get the original query string paramters that were specified on the URL.
 java.lang.String getRemoveAction()
           
 java.lang.String getRemoveBanner()
           
 java.lang.String getRemoveFooter()
           
 java.lang.String getResponseURL()
           
 java.lang.String getReturnUrl()
           
 java.lang.String getURLParameters()
          Get the URL parameters that were specified in the CommandCall constructor.
 java.lang.String getVersion()
           
 java.lang.String getWindowTitle(java.util.Locale locale)
           
 void setAutoConfirm(java.lang.String autoConfirm)
           
 void setCustomCss(java.lang.String customCss)
           
 void setDismissLabel(java.lang.String dismissLabel)
           
 void setDismissUrl(java.lang.String url)
           
 void setId(java.lang.String id)
           
 void setLaunchedWindowId(java.lang.String windowId)
           
 void setParameters(java.util.Map parameters)
           
 void setQueryString(java.lang.String queryString)
           
 void setRemoveAction(java.lang.String removeAction)
           
 void setRemoveBanner(java.lang.String removeBanner)
           
 void setRemoveFooter(java.lang.String removeFooter)
           
 void setResponseURL(java.lang.String targetURL)
           
 void setReturnUrl(java.lang.String url)
           
 void setWindowTitle(java.lang.String windowTitle)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

version

protected java.lang.String version

id

protected int id
Constructor Detail

CommandCall

public CommandCall()

CommandCall

public CommandCall(org.w3c.dom.Document commandCall)
Constructor for thick client XML based command call.

Parameters:
commandCall -

CommandCall

public CommandCall(javax.servlet.http.HttpServletRequest request)
Constructor for web based request based command call.

Parameters:
request -

CommandCall

public CommandCall(com.filenet.wcm.toolkit.server.base.WcmController controller,
                   javax.servlet.http.HttpServletRequest request)
            throws java.lang.Exception
Constructor for web based request based command call.

Parameters:
controller -
request -
Method Detail

getURLParameters

public java.lang.String getURLParameters()
                                  throws java.lang.Exception
Get the URL parameters that were specified in the CommandCall constructor. This method uses the parameters Map that can be populated several different ways depending in the CommandCall type. The actual url parameters MAY get URLdecoded along the way which can have undesired effects with encoded data.

Returns:
String holding URL parameters
Throws:
java.lang.Exception

getClientRequestInfo

public ClientRequestInfo getClientRequestInfo()

getId

public int getId()

setId

public void setId(java.lang.String id)

getName

public java.lang.String getName()

getParameters

public java.util.Map getParameters()

setParameters

public void setParameters(java.util.Map parameters)

getQueryString

public java.lang.String getQueryString()
Get the original query string paramters that were specified on the URL. This method does not call request.getParameter() and therfore the parameter values will not have been URLdecoded.

Returns:
String holding original query string

setQueryString

public void setQueryString(java.lang.String queryString)

getCommandRequestMap

public com.filenet.wcm.toolkit.server.util.WcmRequestMap getCommandRequestMap()
Get the parameters map with all of the integration servlet standard parameters filtered out.

Returns:
WcmRequestMap object

getVersion

public java.lang.String getVersion()

setResponseURL

public void setResponseURL(java.lang.String targetURL)

getResponseURL

public java.lang.String getResponseURL()

setWindowTitle

public void setWindowTitle(java.lang.String windowTitle)

getWindowTitle

public java.lang.String getWindowTitle(java.util.Locale locale)

setDismissLabel

public void setDismissLabel(java.lang.String dismissLabel)

setLaunchedWindowId

public void setLaunchedWindowId(java.lang.String windowId)

setDismissUrl

public void setDismissUrl(java.lang.String url)

setReturnUrl

public void setReturnUrl(java.lang.String url)

setAutoConfirm

public void setAutoConfirm(java.lang.String autoConfirm)

getAutoConfirm

public java.lang.String getAutoConfirm()

getLaunchedWindowId

public java.lang.String getLaunchedWindowId()

getDismissLabel

public java.lang.String getDismissLabel(java.util.Locale locale)

getDismissUrl

public java.lang.String getDismissUrl()

getReturnUrl

public java.lang.String getReturnUrl()

setCustomCss

public void setCustomCss(java.lang.String customCss)

getCustomCss

public java.lang.String getCustomCss()

setRemoveBanner

public void setRemoveBanner(java.lang.String removeBanner)

getRemoveBanner

public java.lang.String getRemoveBanner()

setRemoveFooter

public void setRemoveFooter(java.lang.String removeFooter)

getRemoveFooter

public java.lang.String getRemoveFooter()

setRemoveAction

public void setRemoveAction(java.lang.String removeAction)

getRemoveAction

public java.lang.String getRemoveAction()


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