com.filenet.wcm.toolkit.server.base
Interface WcmControllerBehaviorInterface

All Known Implementing Classes:
WcmController

Deprecated. This interface isn't really being used for anything.

public interface WcmControllerBehaviorInterface

Describes methods that can be overridden in a sub-class of WcmController to customize its behavior.


Method Summary
 void configureDataProviders()
          Deprecated. Implementation must instantiate and register any global data providers.
 void configureHeaderModule()
          Deprecated. Implementation must instantiate and register a UI module that implements WcmHeaderModuleInterface.
 void configurePage(javax.servlet.ServletContext applicationValue, javax.servlet.http.HttpServletRequest request, boolean windowIdRequired)
          Deprecated. Customize the base configurePage behavior (optional).
 java.lang.String getBootstrapPage()
          Deprecated. Return the name of the bootstrap page to go to if bootstrap is required.
 WcmConfigurationInterface getConfiguration()
          Deprecated. Factory method.
 java.lang.String getConfiguredHome()
          Deprecated. Return the configured home page.
 java.lang.String getDefaultPage()
          Deprecated. Return the name of the default page.
 java.lang.String getErrorPage()
          Deprecated. Return the name of the error page.
 WcmHeaderModuleInterface getHeaderModule()
          Deprecated. Gets the registered header module, if defined.
 java.util.Vector getRouters()
          Deprecated. Implement this method to provide a list of the Process Engine routers that your application will be using - in the format "host:port".
 java.lang.String getSignInPage()
          Deprecated. Return the name of the sign in page.
 WcmSignInPolicyInterface getSignInPolicy()
          Deprecated. Factory method.
 WcmSystem getSystemInfo()
          Deprecated. Factory method.
 WcmUserInformationInterface getUserInfo()
          Deprecated. Return the singleton instance of WcmUserInformationInterface if it is currently defined in the session.
 void initializeStaticClasses()
          Deprecated. Implement this method if you have any required static class initialization that requires access to context objects such as ServletContext (application).
 boolean isBootstrapRequired()
          Deprecated. Return true if the bootstrap file needs to be initially configured.
 boolean isControllerEvent(java.lang.String eventName)
          Deprecated. Return true if the named event is a valid controller event (optional).
 boolean isPreControllerEvent(java.lang.String eventName)
          Deprecated. Return true if the named event is a valid "pre" controller event (optional).
 boolean isStickyPage(java.lang.String pageName)
          Deprecated. Return true if the specified page is sticky.
 boolean isValidHome(java.lang.String pageName)
          Deprecated. Return true if the specified page is a valid home page.
 void setLocale(java.util.Locale locale)
          Deprecated. Forward the client locale to any objects that require it.
 

Method Detail

configurePage

public void configurePage(javax.servlet.ServletContext applicationValue,
                          javax.servlet.http.HttpServletRequest request,
                          boolean windowIdRequired)
                   throws java.lang.Exception
Deprecated. 
Customize the base configurePage behavior (optional).

Parameters:
request - The current HttpServletRequest.
windowIdRequired - Specifies if this is intended to be a pop-up window.
Throws:
java.lang.Exception

configureHeaderModule

public void configureHeaderModule()
                           throws java.lang.Exception
Deprecated. 
Implementation must instantiate and register a UI module that implements WcmHeaderModuleInterface. This module is responsible for rendering the HTML headers onto the page.

Throws:
java.lang.Exception

configureDataProviders

public void configureDataProviders()
                            throws java.lang.Exception
Deprecated. 
Implementation must instantiate and register any global data providers. The data providers should also be added via WcmController.addDataProvider.

Throws:
java.lang.Exception

getHeaderModule

public WcmHeaderModuleInterface getHeaderModule()
Deprecated. 
Gets the registered header module, if defined.


getBootstrapPage

public java.lang.String getBootstrapPage()
Deprecated. 
Return the name of the bootstrap page to go to if bootstrap is required.


getConfiguredHome

public java.lang.String getConfiguredHome()
                                   throws java.lang.Exception
Deprecated. 
Return the configured home page. This may be set via a preferences mechanism, or, could be role based.

Throws:
java.lang.Exception

getDefaultPage

public java.lang.String getDefaultPage()
                                throws java.lang.Exception
Deprecated. 
Return the name of the default page. This should be a fixed value.

Throws:
java.lang.Exception

getErrorPage

public java.lang.String getErrorPage()
                              throws java.lang.Exception
Deprecated. 
Return the name of the error page. This should be a fixed value.

Throws:
java.lang.Exception

getSignInPage

public java.lang.String getSignInPage()
Deprecated. 
Return the name of the sign in page. This should be a fixed value.


getRouters

public java.util.Vector getRouters()
                            throws java.lang.Exception
Deprecated. 
Implement this method to provide a list of the Process Engine routers that your application will be using - in the format "host:port".

Throws:
java.lang.Exception

initializeStaticClasses

public void initializeStaticClasses()
                             throws java.lang.Exception
Deprecated. 
Implement this method if you have any required static class initialization that requires access to context objects such as ServletContext (application).

Throws:
java.lang.Exception

isBootstrapRequired

public boolean isBootstrapRequired()
Deprecated. 
Return true if the bootstrap file needs to be initially configured.


isControllerEvent

public boolean isControllerEvent(java.lang.String eventName)
Deprecated. 
Return true if the named event is a valid controller event (optional).

Parameters:
eventName - The name of the event.

isPreControllerEvent

public boolean isPreControllerEvent(java.lang.String eventName)
Deprecated. 
Return true if the named event is a valid "pre" controller event (optional).

Parameters:
eventName - The name of the event.

isValidHome

public boolean isValidHome(java.lang.String pageName)
                    throws java.lang.Exception
Deprecated. 
Return true if the specified page is a valid home page.

Parameters:
pageName - The name of the page.
Throws:
java.lang.Exception

isStickyPage

public boolean isStickyPage(java.lang.String pageName)
Deprecated. 
Return true if the specified page is sticky. This means that when a user signs out from this page, when they sign in, they are returned to it.

Parameters:
pageName - The name of the page.

setLocale

public void setLocale(java.util.Locale locale)
               throws java.lang.Exception
Deprecated. 
Forward the client locale to any objects that require it.

Parameters:
locale - The client locale.
Throws:
java.lang.Exception

getConfiguration

public WcmConfigurationInterface getConfiguration()
                                           throws java.lang.Exception
Deprecated. 
Factory method. Return the singleton instance of WcmConfiguration that implements the configuration object for your controller.

Throws:
java.lang.Exception

getSignInPolicy

public WcmSignInPolicyInterface getSignInPolicy()
                                         throws java.lang.Exception
Deprecated. 
Factory method. Return the singleton instance of WcmSignInPolicyInterface that implements the sign in policy for your controller.

Throws:
java.lang.Exception

getUserInfo

public WcmUserInformationInterface getUserInfo()
                                        throws java.lang.Exception
Deprecated. 
Return the singleton instance of WcmUserInformationInterface if it is currently defined in the session.

Throws:
java.lang.Exception

getSystemInfo

public WcmSystem getSystemInfo()
                        throws java.lang.Exception
Deprecated. 
Factory method. Returns the singleton instance of WcmSystem used with this controller implementation.

Throws:
java.lang.Exception


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