org.apache.myfaces.custom.conversation
Class UIEndConversation

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by org.apache.myfaces.custom.conversation.AbstractConversationComponent
                  extended by org.apache.myfaces.custom.conversation.UIEndConversation
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder

public class UIEndConversation
extends AbstractConversationComponent

end a conversation

Author:
imario@apache.org

Field Summary
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class org.apache.myfaces.custom.conversation.AbstractConversationComponent
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
UIEndConversation()
           
 
Method Summary
 void encodeBegin(javax.faces.context.FacesContext context)
           
 java.lang.String getErrorOutcome()
          on exception use the given outcome for further navigation
 java.lang.String getOnOutcome()
          end the conversation only if the action outcome matches the given onOutcome.
 java.lang.Boolean getRestart()
          true|false|valueBinding - true if the conversation should be restarted immediately
 javax.faces.el.MethodBinding getRestartAction()
          the action which should be called in case of a restart
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setErrorOutcome(java.lang.String errorOutcome)
           
 void setOnOutcome(java.lang.String onOutcome)
           
 void setRestart(java.lang.Boolean restart)
           
 void setRestartAction(javax.faces.el.MethodBinding restartAction)
           
 
Methods inherited from class org.apache.myfaces.custom.conversation.AbstractConversationComponent
getFamily, getName, setName
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

UIEndConversation

public UIEndConversation()
Method Detail

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException
Overrides:
encodeBegin in class javax.faces.component.UIComponentBase
Throws:
java.io.IOException

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class AbstractConversationComponent

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class AbstractConversationComponent

getOnOutcome

public java.lang.String getOnOutcome()
end the conversation only if the action outcome matches the given onOutcome. This can be a comma separated list.

Returns:

setOnOutcome

public void setOnOutcome(java.lang.String onOutcome)

getErrorOutcome

public java.lang.String getErrorOutcome()
on exception use the given outcome for further navigation

Returns:

setErrorOutcome

public void setErrorOutcome(java.lang.String errorOutcome)

getRestart

public java.lang.Boolean getRestart()
true|false|valueBinding - true if the conversation should be restarted immediately

Returns:

setRestart

public void setRestart(java.lang.Boolean restart)

getRestartAction

public javax.faces.el.MethodBinding getRestartAction()
the action which should be called in case of a restart

Returns:

setRestartAction

public void setRestartAction(javax.faces.el.MethodBinding restartAction)


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.