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

java.lang.Object
  org.kuali.rice.krad.uif.lifecycle.AbstractViewLifecyclePhase
      org.kuali.rice.krad.uif.lifecycle.FinalizeComponentPhase

All Implemented Interfaces:

Runnable, ViewLifecyclePhase

public class FinalizeComponentPhase
extends AbstractViewLifecyclePhase

Lifecycle phase processing task for applying the model to a component.

Author:

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

Constructor Summary

FinalizeComponentPhase()

Method Summary

String	getEndViewStatus() Get the expected view status after phase execution.
ViewLifecycle.LifecycleEvent	getEventToNotify() Get the event to notify on completion.
Component	getParent()
String	getStartViewStatus() Get the expected view status prior to phase execution.
String	getViewPhase() Get the view lifecycle phase constant that corresponds to this phase processing task.
protected void	initializePendingTasks(Queue<ViewLifecycleTask> tasks) Update state of the component and perform final preparation for rendering.
protected void	initializeSuccessors(Queue<ViewLifecyclePhase> successors) Define all nested lifecycle components, and component prototypes, as successors.
boolean	isComplete() Determine if this lifecycle phase, and all successor phases, have completed processing.
protected void	notifyCompleted() Override for additional handling when all tasks and successor tasks have been completed for this phase.
protected void	prepare(Component component, Object model, Component parent, FinalizeComponentPhase parentPhase) Create a new lifecycle phase processing task for finalizing a component.
protected void	recycle() Reset this phase for recycling.

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

addTask, getActiveTask, getComponent, getModel, getPendingTasks, getPredecessors, getSuccessors, isProcessed, isReadyToRecycle, prepare, run, toString

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

protected void recycle()

Description copied from class: AbstractViewLifecyclePhase

Reset this phase for recycling.

Overrides:

recycle in class AbstractViewLifecyclePhase

See Also:

AbstractViewLifecyclePhase.recycle()

prepare

protected void prepare(Component component,
                       Object model,
                       Component parent,
                       FinalizeComponentPhase parentPhase)

Create a new lifecycle phase processing task for finalizing a component.

Parameters:

component - The component instance the model should be applied to

model - Top level object containing the data

parentPhase - The finalize phase processed on the parent component.

getViewPhase

public String getViewPhase()

Description copied from interface: ViewLifecyclePhase

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

Returns:

The view lifecycle phase constant that corresponds to this phase processing task.

See Also:

ViewLifecyclePhase.getViewPhase()

getStartViewStatus

public String getStartViewStatus()

Description copied from interface: ViewLifecyclePhase

Get the expected view status prior to phase execution.

Returns:

The expected view status prior to phase execution.

See Also:

ViewLifecyclePhase.getStartViewStatus()

getEndViewStatus

public String getEndViewStatus()

Description copied from interface: ViewLifecyclePhase

Get the expected view status after phase execution.

Returns:

The expected view status after phase execution.

See Also:

ViewLifecyclePhase.getEndViewStatus()

getEventToNotify

public ViewLifecycle.LifecycleEvent getEventToNotify()

Description copied from interface: ViewLifecyclePhase

Get the event to notify on completion.

Returns:

The lifecycle event to notify on completion.

See Also:

ViewLifecyclePhase.getEventToNotify()

notifyCompleted

protected void notifyCompleted()

Description copied from class: AbstractViewLifecyclePhase

Override for additional handling when all tasks and successor tasks have been completed for this phase.

Overrides:

notifyCompleted in class AbstractViewLifecyclePhase

See Also:

AbstractViewLifecyclePhase.notifyCompleted()

isComplete

public boolean isComplete()

Description copied from interface: ViewLifecyclePhase

Determine if this lifecycle phase, and all successor phases, have completed processing.

Specified by:

isComplete in interface ViewLifecyclePhase

Overrides:

isComplete in class AbstractViewLifecyclePhase

Returns:

True if this phase and all successor phases have been processed, false if not.

See Also:

AbstractViewLifecyclePhase.isComplete()

getParent

public Component getParent()

Returns:

the parent

initializePendingTasks

protected void initializePendingTasks(Queue<ViewLifecycleTask> tasks)

Update state of the component and perform final preparation for rendering.

Specified by:

initializePendingTasks in class AbstractViewLifecyclePhase

Parameters:

tasks - The queue of tasks to perform.

See Also:

AbstractViewLifecyclePhase.initializePendingTasks(java.util.Queue)

initializeSuccessors

protected void initializeSuccessors(Queue<ViewLifecyclePhase> successors)

Define all nested lifecycle components, and component prototypes, as successors.

Specified by:

initializeSuccessors in class AbstractViewLifecyclePhase

See Also:

org.kuali.rice.krad.uif.lifecycle.AbstractViewLifecyclePhase#initializeSuccessors(java.util.List)