javax.portlet.faces.event
Class EventNavigationResult

java.lang.Object
  javax.portlet.faces.event.EventNavigationResult

public class EventNavigationResult
extends java.lang.Object

An EventNavigationResult is the type of object that can be returned from a BrdigeEventHandler.handleEvent call. When it is returned (non-null) it conveys the Faces navigation information to the bridge that it needs to utilize the Faces NavigationHandler to evaluate the navigation according to the configured rules. The fromAction corresponds to the fromAction string in the faces-config.xml navigation rule. The outcome corresponds to the outcome string in the navigation rule.

Constructor Summary

EventNavigationResult()
Null constructor

EventNavigationResult(java.lang.String action, java.lang.String outcome)
Constructor which sets the object to the desired fromAction and outcome

Method Summary

java.lang.String	getFromAction() Gets the fromAction stored in this object.
java.lang.String	getOutcome() Gets the outcome stored in this object.
void	setFromAction(java.lang.String action) Sets the fromAction for this object.
void	setOutcome(java.lang.String outcome) Sets the fromAction for this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventNavigationResult

public EventNavigationResult()

Null constructor

EventNavigationResult

public EventNavigationResult(java.lang.String action,
                             java.lang.String outcome)

Constructor which sets the object to the desired fromAction and outcome

Parameters:

action - desired fromAction

outcome - desired outcome

Method Detail

getFromAction

public java.lang.String getFromAction()

Gets the fromAction stored in this object. The fromAction corresponds to the fromAction string in the faces-config.xml navigation rule.

Returns:

String containing the fromAction

setFromAction

public void setFromAction(java.lang.String action)

Sets the fromAction for this object. The fromAction corresponds to the fromAction string in the faces-config.xml navigation rule.

Parameters:

action - new fromAction

getOutcome

public java.lang.String getOutcome()

Gets the outcome stored in this object. The outcome corresponds to the outcome string in the faces-config.xml navigation rule.

Returns:

String containing the fromAction

setOutcome

public void setOutcome(java.lang.String outcome)

Sets the fromAction for this object. The fromAction corresponds to the fromAction string in the faces-config.xml navigation rule.

Parameters:

outcome - new outcome