org.apache.beehive.netui.pageflow
Interface PageFlowControlContainer

All Known Implementing Classes:
PageFlowControlContainerImpl

public interface PageFlowControlContainer


Method Summary
 void beginContextOnPageFlow(PageFlowManagedObject pfmo, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
          This method will perform the beginContext() on any and all ControlContainerContext objects that are managed by the page flow runtime.
 void createAndBeginControlBeanContext(PageFlowManagedObject pfmo, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
          This method will ensure that a page flow's ControlContainerContext exists, and will make make sure that the begin context is called.
 void endContextOnPageFlow(PageFlowManagedObject flowController)
          This method will perform the endContext() on any and all ControlContainerContext objects that are managed by the page flow runtime.
 ControlContainerContext getControlContainerContext(PageFlowManagedObject pfmo)
          This will return the page flows ControlContainerContext.
 

Method Detail

createAndBeginControlBeanContext

void createAndBeginControlBeanContext(PageFlowManagedObject pfmo,
                                      HttpServletRequest request,
                                      HttpServletResponse response,
                                      ServletContext servletContext)
This method will ensure that a page flow's ControlContainerContext exists, and will make make sure that the begin context is called. Once this is called, you must insure that the endContext method is called. This is typically called when a page flow instance is being created. If a Control bean is created programmatically in a page flow using java.beans.Beans#instantiate(ClassLoader, String), without @Control annotations, you must call this method on the page flow object before the bean is instantiated.

Parameters:
pfmo -
request -
response -
servletContext -

getControlContainerContext

ControlContainerContext getControlContainerContext(PageFlowManagedObject pfmo)
This will return the page flows ControlContainerContext. This call should be made after either the createAndBeginControlBeanContext or beginContextOnPageFlow has been called.

Parameters:
pfmo -
Returns:
Returns the ControlContainerContext for the page flow. This may return null if the page flow currently doesn't have a ControlContainerContext context.

beginContextOnPageFlow

void beginContextOnPageFlow(PageFlowManagedObject pfmo,
                            HttpServletRequest request,
                            HttpServletResponse response,
                            ServletContext servletContext)
This method will perform the beginContext() on any and all ControlContainerContext objects that are managed by the page flow runtime. If you call this, you must call the endContextOnPageFlow method is also called. The implementation may hold locks on the control container and not calling the endContext may result in hangs and deadlocks.

Parameters:
pfmo -
request -
response -
servletContext -

endContextOnPageFlow

void endContextOnPageFlow(PageFlowManagedObject flowController)
This method will perform the endContext() on any and all ControlContainerContext objects that are managed by the page flow runtime.

Parameters:
flowController -