org.kuali.rice.krad.uif.lifecycle

Interface ViewLifecyclePhase

All Superinterfaces:

LifecycleElementState, Runnable

All Known Implementing Classes:

ApplyModelComponentPhase, FinalizeComponentPhase, InitializeComponentPhase, PreProcessElementPhase, RenderComponentPhase, ViewLifecyclePhaseBase

public interface ViewLifecyclePhase
extends LifecycleElementState, Runnable

Represents a phase in the view lifecycle.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
ViewLifecycleTask<?>	getCurrentTask() Gets the task currently running.
String	getEndViewStatus() Gets the expected view status after phase execution.
ViewLifecycle.LifecycleEvent	getEventToNotify() Gets the event to notify on completion.
Object	getModel() Gets the model to use in processing this phase.
Component	getParent() Gets the parent component.
ViewLifecyclePhase	getPredecessor() Gets the lifecycle phase that directly precedes this phase.
List<String>	getRefreshPaths() When a refresh component lifecycle is being processed, list of paths the lifecycle should be invoked on (including the path for the component that is being refreshed).
String	getStartViewStatus() Gets the expected view status prior to phase execution.
boolean	isComplete() Determines if this lifecycle phase and all successor phases, have completed processing.
boolean	isProcessed() Determines if this lifecycle phase has completed processing.

Methods inherited from interface org.kuali.rice.krad.uif.lifecycle.LifecycleElementState

getDepth, getElement, getParentPath, getViewPath, getViewPhase

Methods inherited from interface java.lang.Runnable

run

Method Detail

getModel

Object getModel()

Gets the model to use in processing this phase.

Returns:

model to use in processing this phase

getParent

Component getParent()

Gets the parent component.

Returns:

parent component

getRefreshPaths

List<String> getRefreshPaths()

When a refresh component lifecycle is being processed, list of paths the lifecycle should be invoked on (including the path for the component that is being refreshed).

Returns:

list of component paths (relative to the view)

isProcessed

boolean isProcessed()

Determines if this lifecycle phase has completed processing.

This method will return true when this phase's tasks have been processed, but does not necessarily indicate that successor phases have been completed. Use isComplete() to determine if the lifecycle has been fully completed for this phase.

Returns:

true if this phase has been processed, false if not

isComplete

boolean isComplete()

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

Returns:

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

See Also:

LifecycleElement.notifyCompleted(ViewLifecyclePhase)

getCurrentTask

ViewLifecycleTask<?> getCurrentTask()

Gets the task currently running.

Returns:

the task currently running, null if this phase is not active.

getEventToNotify

ViewLifecycle.LifecycleEvent getEventToNotify()

Gets the event to notify on completion.

Returns:

lifecycle event to notify on completion

See Also:

ViewLifecycle.LifecycleEvent

getStartViewStatus

String getStartViewStatus()

Gets the expected view status prior to phase execution.

Returns:

expected view status prior to phase execution

getEndViewStatus

String getEndViewStatus()

Gets the expected view status after phase execution.

Returns:

expected view status after phase execution

getPredecessor

ViewLifecyclePhase getPredecessor()

Gets the lifecycle phase that directly precedes this phase.

Returns:

lifecycle phase that directly precedes this phase