javax.portlet.faces.event

Class EventNavigationResult

java.lang.Object

javax.portlet.faces.event.EventNavigationResult

public class EventNavigationResult
extends 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

Constructors

Constructor and Description
EventNavigationResult()
EventNavigationResult(String fromAction, String outcome)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getFromAction() Gets the fromAction stored in this object.
String	getOutcome() Gets the outcome stored in this object.
int	hashCode()
void	setFromAction(String fromAction) Sets the fromAction for this object.
void	setOutcome(String outcome) Sets the fromAction for this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventNavigationResult

public EventNavigationResult()

EventNavigationResult

public EventNavigationResult(String fromAction,
                     String outcome)

Parameters:

fromAction -

outcome -

Method Detail

getFromAction

public 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(String fromAction)

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 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(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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object