Project Documentation


Tag name: <s:endConversation>
UIComponent class: org.apache.myfaces.custom.conversation.UIEndConversation
Tag class: org.apache.myfaces.custom.conversation.EndConversationTag
Component type: org.apache.myfaces.EndConversation
Component family: javax.faces.Component
Renderer type: javax.faces.Button

end a conversation


Name Type Supports EL? Description
action javax.faces.el.MethodBinding Yes Specifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal.
actionListener javax.faces.el.MethodBinding Only EL A method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.
binding String Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
errorOutcome String Yes on exception use the given outcome for further navigation
id String Yes An identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

immediate boolean Yes A boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.
name String Yes the name of the conversation. Notice: required if tag not as child of startConversation tag.
onOutcome String Yes end the conversation only if the action outcome matches the given onOutcome. This can be a comma separated list.
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
restart Boolean Yes true|false|valueBinding - true if the conversation should be restarted immediately
restartAction javax.faces.el.MethodBinding Only EL the action which should be called in case of a restart
value Object Yes The initial value of this component.