com.filenet.wcm.apps.server.ui.filemanagement
Class FileManagementModule

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.apps.server.ui.filemanagement.FileManagementModule
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
CancelCheckoutOperation.CancelCheckoutFileManagement, DeleteLocalFileOperation.DeleteLocalFileManagement, DownloadFileManagement, WcmFileSelectWizardPage.FileUploadManagementModule, WcmSaveOperation.SaveFileManagement

public abstract class FileManagementModule
extends com.filenet.wcm.toolkit.server.base.WcmUiModule


Field Summary
static java.lang.String BODY_ONLOAD_FUNCTION_NAME
           
protected  com.filenet.wcm.toolkit.server.base.WcmController controller
           
protected  FileManagementUtil.FileControl fileControl
           
static java.lang.String INIITIALIZE_PAGE_FUNCTION_NAME
           
static java.lang.String ON_FINISHED_EVENT_NAME
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
FileManagementModule()
           
 
Method Summary
 java.lang.String getCallBackUrl()
           
protected abstract  java.lang.String getCommandXML(boolean isSecured)
           
protected  java.lang.String getControlNotLoadedRedirectUrl()
          Returns that URL that is used to redirect the window to a non activeX page since the activeX could not be loaded.
 java.lang.String getControlNotLoadedUrl()
           
protected abstract  java.lang.String getDescriptorXML()
           
protected abstract  java.lang.String getDisplayXML(FileManagementUtil.FileControl fileControl)
           
protected  java.lang.String getDownloadStatusUrl(java.lang.String filePath)
          Deprecated.  
protected abstract  java.lang.String getFileManagementXML()
           
protected abstract  java.lang.String getFileTrackingXML()
           
protected abstract  java.lang.String getStatusUrl(java.lang.String filePath)
           
protected  java.lang.String getUploadStatusUrl(java.lang.String filePath)
          Deprecated.  
 void initialize()
           
protected abstract  FileManagementUtil.FileControl initializeFileControl()
           
 void onCallBack(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The default event handler sets up the display objects for rendering.
 void onControlNotLoaded(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event Handler for handling the case where the Active-X control is not installed on the client machine or cannot be loaded for some reason
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void render(java.io.Writer w)
           
 void setFinishUrl(java.lang.String url)
           
static boolean useFileTracking(com.filenet.wcm.toolkit.server.util.WcmDataStore dataStore, WcmSitePrefs sitePrefs, com.filenet.wcm.toolkit.server.util.UserAgent userAgent)
           
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
subscribeGlobalEvent
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

BODY_ONLOAD_FUNCTION_NAME

public static final java.lang.String BODY_ONLOAD_FUNCTION_NAME
See Also:
Constant Field Values

INIITIALIZE_PAGE_FUNCTION_NAME

public static final java.lang.String INIITIALIZE_PAGE_FUNCTION_NAME
See Also:
Constant Field Values

ON_FINISHED_EVENT_NAME

public static final java.lang.String ON_FINISHED_EVENT_NAME
See Also:
Constant Field Values

controller

protected com.filenet.wcm.toolkit.server.base.WcmController controller

fileControl

protected FileManagementUtil.FileControl fileControl
Constructor Detail

FileManagementModule

public FileManagementModule()
Method Detail

useFileTracking

public static boolean useFileTracking(com.filenet.wcm.toolkit.server.util.WcmDataStore dataStore,
                                      WcmSitePrefs sitePrefs,
                                      com.filenet.wcm.toolkit.server.util.UserAgent userAgent)
                               throws java.lang.Exception
Throws:
java.lang.Exception

initialize

public void initialize()
                throws java.lang.Exception
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Throws:
java.lang.Exception

getControlNotLoadedUrl

public java.lang.String getControlNotLoadedUrl()
                                        throws java.lang.Exception
Throws:
java.lang.Exception

getCallBackUrl

public java.lang.String getCallBackUrl()
                                throws java.lang.Exception
Throws:
java.lang.Exception

setFinishUrl

public void setFinishUrl(java.lang.String url)

onControlNotLoaded

public void onControlNotLoaded(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.lang.Exception
Event Handler for handling the case where the Active-X control is not installed on the client machine or cannot be loaded for some reason

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

getControlNotLoadedRedirectUrl

protected java.lang.String getControlNotLoadedRedirectUrl()
                                                   throws java.lang.Exception
Returns that URL that is used to redirect the window to a non activeX page since the activeX could not be loaded.

Returns:
String The url of a corresponding non activeX version page.
Throws:
java.lang.Exception

onCallBack

public void onCallBack(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
The default event handler sets up the display objects for rendering.

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

initializeFileControl

protected abstract FileManagementUtil.FileControl initializeFileControl()

getDescriptorXML

protected abstract java.lang.String getDescriptorXML()

getCommandXML

protected abstract java.lang.String getCommandXML(boolean isSecured)
                                           throws java.lang.Exception
Throws:
java.lang.Exception

getFileTrackingXML

protected abstract java.lang.String getFileTrackingXML()
                                                throws java.lang.Exception
Throws:
java.lang.Exception

getFileManagementXML

protected abstract java.lang.String getFileManagementXML()
                                                  throws java.lang.Exception
Throws:
java.lang.Exception

getDisplayXML

protected abstract java.lang.String getDisplayXML(FileManagementUtil.FileControl fileControl)

getStatusUrl

protected abstract java.lang.String getStatusUrl(java.lang.String filePath)
                                          throws java.lang.Exception
Throws:
java.lang.Exception

getUploadStatusUrl

protected java.lang.String getUploadStatusUrl(java.lang.String filePath)
                                       throws java.lang.Exception
Deprecated.  

Throws:
java.lang.Exception

getDownloadStatusUrl

protected java.lang.String getDownloadStatusUrl(java.lang.String filePath)
                                         throws java.lang.Exception
Deprecated.  

Throws:
java.lang.Exception


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