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

java.lang.Object
  org.kuali.rice.krad.uif.lifecycle.ViewLifecyclePhaseBase
      org.kuali.rice.krad.uif.lifecycle.PreProcessElementPhase

All Implemented Interfaces:

Runnable, LifecycleElementState, ViewLifecyclePhase

public class PreProcessElementPhase
extends ViewLifecyclePhaseBase

Lifecycle phase implementation representing the pre-process phase.

Author:

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

Constructor Summary

PreProcessElementPhase()

Method Summary

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	initializePendingTasks(Queue<ViewLifecycleTask<?>> tasks) Initializes queue of pending tasks phases.
protected ViewLifecyclePhase	initializeSuccessor(LifecycleElement nestedElement, String nestedPath, Component nestedParent) Initializes a successor of this phase for a given nested element.

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

getCurrentTask, getDepth, getElement, getModel, getNestedPropertiesForRefreshPath, getParent, getParentPath, getPredecessor, getRefreshPaths, getViewPath, initializeAllLifecycleSuccessors, initializeRefreshPathSuccessors, initializeSuccessors, isComplete, isProcessed, notifyCompleted, prepare, processSuccessors, recycle, run, setViewPath, shouldSkipLifecycle, toString, trace, validateBeforeProcessing, verifyCompleted

Methods inherited from class java.lang.Object

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

Constructor Detail

PreProcessElementPhase

public PreProcessElementPhase()

Method Detail

getEventToNotify

public ViewLifecycle.LifecycleEvent getEventToNotify()

Gets the event to notify on completion.

Returns:

lifecycle event to notify on completion

See Also:

ViewLifecycle.LifecycleEvent

getStartViewStatus

public String getStartViewStatus()

Gets the expected view status prior to phase execution.

Returns:

expected view status prior to phase execution

getEndViewStatus

public String getEndViewStatus()

Gets the expected view status after phase execution.

Returns:

expected view status after phase execution

getViewPhase

public String getViewPhase()

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

Returns:

view lifecycle phase constant corresponding to this phase

See Also:

UifConstants.ViewPhases

initializePendingTasks

protected void initializePendingTasks(Queue<ViewLifecycleTask<?>> tasks)

Initializes queue of pending tasks phases.

This method will be called before during processing to determine which tasks to perform at this phase.

Specified by:

initializePendingTasks in class ViewLifecyclePhaseBase

Parameters:

tasks - The queue of tasks to perform.

initializeSuccessor

protected ViewLifecyclePhase initializeSuccessor(LifecycleElement nestedElement,
                                                 String nestedPath,
                                                 Component nestedParent)

Initializes a successor of this phase for a given nested element.

Specified by:

initializeSuccessor in class ViewLifecyclePhaseBase

Parameters:

nestedElement - The lifecycle element.

nestedPath - The path, relative to the parent element.

nestedParent - The parent component of the nested element.

Returns:

successor phase