com.icesoft.faces.async.render
Interface Renderable

public interface Renderable

The Renderable interface represents the PersistentFacesState of a managed bean to the rest of the classes in the Rendering API.

Author:

ICEsoft Technologies, Inc.

Method Summary

PersistentFacesState	getState() Return the reference to the PersistentFacesState associated with this Renderable.
void	renderingException(RenderingException renderingException) Callback method that is called if any exception occurs during an attempt to render this Renderable.

Method Detail

getState

public PersistentFacesState getState()

Return the reference to the PersistentFacesState associated with this Renderable.

The typical (and recommended usage) is to get and hold a reference to the PersistentFacesState in the constructor of your managed bean and return that reference from this method.

Returns:

the PersistentFacesState associated with this Renderable

renderingException

public void renderingException(RenderingException renderingException)

Callback method that is called if any exception occurs during an attempt to render this Renderable.

It is up to the application developer to implement appropriate policy when a RenderingException occurs. Different policies might be appropriate based on the severity of the exception. For example, if the exception is fatal (the session has expired), no further attempts should be made to render this Renderable and the application may want to remove the Renderable from some or all of the GroupAsyncRenderers it belongs to. If it is a transient exception (like a client's connection is temporarily unavailable) then the application has the option of removing the Renderable from GroupRenderers or leaving them and allowing another render call to be attempted.

Parameters:

renderingException - The exception that occurred when attempting to render this Renderable.