com.filenet.wcm.apps.server.util.integration
Interface CommandService

All Known Implementing Classes:
CheckinCommandService, EntryTemplateCommandService, FormCommandService, GetInfoCommandService, ServletCommandService

public interface CommandService


Method Summary
 ResponseCall getResponseCall(CommandCall command, java.lang.String windowId, javax.servlet.http.HttpServletRequest request, WcmWorkplaceController wwc)
          For dispatching to URL's that go outside of Workplace, a return URL of http://host/Workplace/integrationResponseProxy?windowId=C_...
 void handleCommand(CommandCall command, java.lang.String setWindowId, java.lang.String proxyReturnURL, com.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject commandPrefs, javax.servlet.http.HttpServletResponse response, WcmWorkplaceController wwc)
          Handle an integration servlet command that requires special processing in order to determine its final destination.
 boolean registerModules(WcmWorkplaceController wwc)
          Return true if data providers were registered or if authentication is required.
 

Method Detail

handleCommand

public void handleCommand(CommandCall command,
                          java.lang.String setWindowId,
                          java.lang.String proxyReturnURL,
                          com.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject commandPrefs,
                          javax.servlet.http.HttpServletResponse response,
                          WcmWorkplaceController wwc)
                   throws com.filenet.wcm.toolkit.util.WcmException
Handle an integration servlet command that requires special processing in order to determine its final destination. If there is any problem forwarding to the command URL, throw a WcmException.

Parameters:
command -
setWindowId -
commandPrefs -
response -
Throws:
com.filenet.wcm.toolkit.util.WcmException

registerModules

public boolean registerModules(WcmWorkplaceController wwc)
                        throws com.filenet.wcm.toolkit.util.WcmException
Return true if data providers were registered or if authentication is required.

Parameters:
wwc -
Returns:
true or false
Throws:
com.filenet.wcm.toolkit.util.WcmException

getResponseCall

public ResponseCall getResponseCall(CommandCall command,
                                    java.lang.String windowId,
                                    javax.servlet.http.HttpServletRequest request,
                                    WcmWorkplaceController wwc)
                             throws com.filenet.wcm.toolkit.util.WcmException
For dispatching to URL's that go outside of Workplace, a return URL of http://host/Workplace/integrationResponseProxy?windowId=C_... can be specified. If this is done, when the command returns, this method will be called so that the request parameters coming from the called URL can be examined and an appropriate ResponseCall constructed. If null is returned, the IntegrationServlet will perform default behavior for sending the response.

Parameters:
command -
request -
wwc -
Returns:
The populated ResponseCall object ready for sending, or null.
Throws:
com.filenet.wcm.toolkit.util.WcmException


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