Package org.kuali.rice.krad.uif.lifecycle

Interface ViewLifecycleProcessor

All Known Implementing Classes:
AsynchronousViewLifecycleProcessor, SynchronousViewLifecycleProcessor, ViewLifecycleProcessorBase
public interface ViewLifecycleProcessor
Interface for controlling the execution of the view lifecycle.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • performPhase

      void performPhase(ViewLifecyclePhase initialPhase)
      Performs a lifecycle phase according to this processor's semantics, blocking until the phase has been completely processed. Once the initial phase has been completely processed, this method will return.
      Parameters:
      initialPhase - The initial lifecycle phase

    • pushPendingPhase

      void pushPendingPhase(ViewLifecyclePhase phase)
      Pushes lifecycle phases to be processed within the lifecycle associated with this processor.

      A phase submitted using this method will be added to the front of the queue, to be processed by the next available processor.

      Parameters:
      phase - The phase to be processed within the lifecycle associated with this processor.

    • offerPendingPhase

      void offerPendingPhase(ViewLifecyclePhase phase)
      Queues a lifecycle phase to be processed within the lifecycle associated with this processor.

      A phase submitted using this method will be added to the end of the queue, to be processed after all other phases currently in the queue have been submitted.

      Parameters:
      phase - The phase to be processed within the lifecycle associated with this processor.

    • getActivePhase

      ViewLifecyclePhase getActivePhase()
      Gets the phase actively being processing on the current thread.
      Returns:
      lifecycle phase active on the current thread

    • getLifecycle

      ViewLifecycle getLifecycle()
      Gets the lifecycle associated with this processor.
      Returns:
      lifecycle associated with this processor

    • getRenderingContext

      LifecycleRenderingContext getRenderingContext()
      Gets a thread-local rending context for invoking FreeMarker operations on the current thread.
      Returns:
      rending context for invoking FreeMarker operations on the current thread

    • getExpressionEvaluator

      ExpressionEvaluator getExpressionEvaluator()
      Returns an instance of ExpressionEvaluator that can be used for evaluating expressions contained on the view.

      A ExpressionEvaluator must be initialized with a model for expression evaluation. One instance is constructed for the view lifecycle and made available to all components/helpers through this method

      Returns:
      instance of ExpressionEvaluator