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 BridgeEventHandler.handleEvent(FacesContext, Event) call. When it is returned as a (non-null) value, 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.

Author:

Michael Freedman, Neil Griffin

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getFromAction()
String	getOutcome()
void	setFromAction(String fromAction) Sets the value that corresponds to the <from-action> element of a navigation-rule.
void	setOutcome(String outcome) Sets the value that corresponds to the <outcome> element of a navigation-rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventNavigationResult

public EventNavigationResult()

EventNavigationResult

public EventNavigationResult(String fromAction,
                             String outcome)

Constructor which sets the object to the desired fromAction and outcome.

Parameters:

fromAction - Value corresponding to the <from-action> element of a navigation-rule.

outcome - Value corresponding to the <outcome> element of a navigation-rule.

Method Detail

getFromAction

public String getFromAction()

Returns:

Value corresponding to the <from-action> element of a navigation-rule.

getOutcome

public String getOutcome()

Returns:

Value corresponding to the <outcome> element of a navigation-rule.

setFromAction

public void setFromAction(String fromAction)

Sets the value that corresponds to the <from-action> element of a navigation-rule.

Parameters:

fromAction - The value that corresponds to the <from-action> element of a navigation-rule.

setOutcome

public void setOutcome(String outcome)

Sets the value that corresponds to the <outcome> element of a navigation-rule.

Parameters:

outcome - The value that corresponds to the <from-action> element of a navigation-rule.