org.kuali.rice.krad.uif.lifecycle

Class FinalizeComponentPhase

java.lang.Object

org.kuali.rice.krad.uif.lifecycle.ViewLifecyclePhaseBase

org.kuali.rice.krad.uif.lifecycle.FinalizeComponentPhase

All Implemented Interfaces:

Runnable, LifecycleElementState, ViewLifecyclePhase

public class FinalizeComponentPhase
extends ViewLifecyclePhaseBase

Lifecycle phase processing task for finalizing a component.

The finalize phase is the last phase before the view is rendered. Here final preparations can be made based on the updated view state.

The finalize phase runs after the apply model phase and can be called multiple times for the view's lifecylce (however typically only once per request)

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

Constructors

Constructor and Description
FinalizeComponentPhase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getEndViewStatus() Gets the expected view status after phase execution.
ViewLifecycle.LifecycleEvent	getEventToNotify() Gets the event to notify on completion.
String	getStartViewStatus() Gets the expected view status prior to phase execution.
String	getViewPhase() Gets the view lifecycle phase constant that corresponds to this phase processing task.
protected void	initializeSuccessors(Queue<ViewLifecyclePhase> successors) Initializes queue of successor phases.
void	recycle() Resets this phase for recycling.
protected void	verifyCompleted() Verify that the render phase has no pending children.

Methods inherited from class org.kuali.rice.krad.uif.lifecycle.ViewLifecyclePhaseBase

getCurrentTask, getDepth, getElement, getNestedPropertiesForRefreshPath, getParent, getParentPath, getPredecessor, getRefreshPaths, getViewPath, hasPendingSuccessors, initializeAllLifecycleSuccessors, initializeRefreshPathSuccessors, initializeSuccessor, isComplete, isProcessed, notifyCompleted, prepare, processSuccessors, removePendingSuccessor, run, setNextPhase, setPredecessor, setRefreshPaths, setSkipLifecycleTasks, setTasks, setViewPath, shouldSkipLifecycle, toString, trace, validateBeforeProcessing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FinalizeComponentPhase

public FinalizeComponentPhase()

Method Detail

recycle

public void recycle()

Resets this phase for recycling.

Specified by:

recycle in interface ViewLifecyclePhase

Overrides:

recycle in class ViewLifecyclePhaseBase

getViewPhase

public String getViewPhase()

Gets the view lifecycle phase constant that corresponds to this phase processing task.

Returns:

UifConstants.ViewPhases.FINALIZE

See Also:

UifConstants.ViewPhases

getStartViewStatus

public String getStartViewStatus()

Gets the expected view status prior to phase execution.

Returns:

UifConstants.ViewStatus.MODEL_APPLIED

getEndViewStatus

public String getEndViewStatus()

Gets the expected view status after phase execution.

Returns:

UifConstants.ViewStatus.FINAL

getEventToNotify

public ViewLifecycle.LifecycleEvent getEventToNotify()

Gets the event to notify on completion.

Returns:

LifecycleEvent.LIFECYCLE_COMPLETE

See Also:

ViewLifecycle.LifecycleEvent

verifyCompleted

protected void verifyCompleted()

Verify that the render phase has no pending children.

Overrides:

verifyCompleted in class ViewLifecyclePhaseBase

initializeSuccessors

protected void initializeSuccessors(Queue<ViewLifecyclePhase> successors)

Initializes queue of successor phases.

This method will be called while processing this phase after all tasks have been performed, to determine phases to queue for successor processing. This phase will not be considered complete until all successors queued by this method, and all subsequent successor phases, have completed processing.

Overrides:

initializeSuccessors in class ViewLifecyclePhaseBase

Parameters:

successors - The queue of successor phases