org.kuali.rice.krad.uif.lifecycle

Class ApplyModelComponentPhase

java.lang.Object

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

org.kuali.rice.krad.uif.lifecycle.ApplyModelComponentPhase

All Implemented Interfaces:

Runnable, LifecycleElementState, ViewLifecyclePhase

public class ApplyModelComponentPhase
extends ViewLifecyclePhaseBase

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

During the apply model phase each component of the tree if invoked to setup any state based on the given model data

Part of the view lifecycle that applies the model data to the view. Should be called after the model has been populated before the view is rendered. The main things that occur during this phase are:

• Generation of dynamic fields (such as collection rows)
• Execution of conditional logic (hidden, read-only, required settings based on model values)

The update phase can be called multiple times for the view's lifecycle (typically only once per request)

Author:

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

Constructor Summary

Constructors

Constructor and Description
ApplyModelComponentPhase()

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.
boolean	visit(LifecycleElement element) Visit a lifecycle element.

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

getCurrentTask, getDepth, getElement, getNestedPropertiesForRefreshPath, getParent, getParentPath, getPredecessor, getRefreshPaths, getViewPath, hasPendingSuccessors, initializeAllLifecycleSuccessors, initializeRefreshPathSuccessors, initializeSuccessor, initializeSuccessors, isComplete, isProcessed, notifyCompleted, prepare, processSuccessors, recycle, removePendingSuccessor, run, setNextPhase, setPredecessor, setRefreshPaths, setSkipLifecycleTasks, setTasks, 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

ApplyModelComponentPhase

public ApplyModelComponentPhase()

Method Detail

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

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

getEventToNotify

public ViewLifecycle.LifecycleEvent getEventToNotify()

Gets the event to notify on completion.

Returns:

lifecycle event to notify on completion

See Also:

ViewLifecycle.LifecycleEvent

visit

public boolean visit(LifecycleElement element)

Visit a lifecycle element.

Parameters:

element - The lifecycle element (component or layout manager) to mark as visisted.

Returns:

True if the element has been visited before, false if this was the first visit.