org.jboss.seam.navigation
Class Param

java.lang.Object
  org.jboss.seam.navigation.Param

public final class Param
extends java.lang.Object

Metadata for a <param/> in pages.xml

Author:

Gavin King

Field Summary

static java.lang.String	INVALID_MESSAGE_ID
static java.lang.String	REQUIRED_MESSAGE_ID

Constructor Summary

Param(java.lang.String name)

Param(java.lang.String name, boolean validateModel)

Method Summary

java.lang.Object	convertValueFromString(javax.faces.context.FacesContext facesContext, java.lang.String value) Convert the string value of a page parameter to the required type
javax.faces.convert.Converter	getConverter()
java.lang.String	getConverterId()
Expressions.ValueExpression	getConverterValueExpression()
java.lang.String	getName()
java.lang.String	getStringValueFromModel(javax.faces.context.FacesContext facesContext) Get the current value of a page or redirection parameter from the model, and convert to a String
java.lang.String	getStringValueFromRequest(javax.faces.context.FacesContext facesContext, java.util.Map<java.lang.String,java.lang.String[]> requestParameters) Get the current value of a page parameter from the request parameters
javax.faces.validator.Validator	getValidator()
java.lang.String	getValidatorId()
Expressions.ValueExpression	getValidatorValueExpression()
Expressions.ValueExpression	getValueExpression()
boolean	isRequired()
boolean	isValidateModel()
void	setConverterId(java.lang.String converterId)
void	setConverterValueExpression(Expressions.ValueExpression converterValueExpression)
void	setRequired(boolean required)
void	setValidateModel(boolean validateModel)
void	setValidatorId(java.lang.String validatorId)
void	setValidatorValueExpression(Expressions.ValueExpression validatorValueExpression)
void	setValueExpression(Expressions.ValueExpression valueExpression)
java.lang.String	toString()
void	validateConvertedValue(javax.faces.context.FacesContext facesContext, java.lang.Object value) Validate the pre-converted value of the parameter using the JSF validator specified in pages.xml, and using Hibernate Validator annotations specified on the model.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_MESSAGE_ID

public static final java.lang.String INVALID_MESSAGE_ID

See Also:

Constant Field Values

REQUIRED_MESSAGE_ID

public static final java.lang.String REQUIRED_MESSAGE_ID

See Also:

Constant Field Values

Constructor Detail

Param

public Param(java.lang.String name)

Param

public Param(java.lang.String name,
             boolean validateModel)

Method Detail

getConverter

public javax.faces.convert.Converter getConverter()

getValidator

public javax.faces.validator.Validator getValidator()

getName

public java.lang.String getName()

setValueExpression

public void setValueExpression(Expressions.ValueExpression valueExpression)

getValueExpression

public Expressions.ValueExpression getValueExpression()

setConverterValueExpression

public void setConverterValueExpression(Expressions.ValueExpression converterValueExpression)

getConverterValueExpression

public Expressions.ValueExpression getConverterValueExpression()

setConverterId

public void setConverterId(java.lang.String converterId)

getConverterId

public java.lang.String getConverterId()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStringValueFromModel

public java.lang.String getStringValueFromModel(javax.faces.context.FacesContext facesContext)

Get the current value of a page or redirection parameter from the model, and convert to a String

getStringValueFromRequest

public java.lang.String getStringValueFromRequest(javax.faces.context.FacesContext facesContext,
                                                  java.util.Map<java.lang.String,java.lang.String[]> requestParameters)
                                           throws javax.faces.validator.ValidatorException

Get the current value of a page parameter from the request parameters

Throws:

javax.faces.validator.ValidatorException

convertValueFromString

public java.lang.Object convertValueFromString(javax.faces.context.FacesContext facesContext,
                                               java.lang.String value)

Convert the string value of a page parameter to the required type

validateConvertedValue

public void validateConvertedValue(javax.faces.context.FacesContext facesContext,
                                   java.lang.Object value)

Validate the pre-converted value of the parameter using the JSF validator specified in pages.xml, and using Hibernate Validator annotations specified on the model.

getValidatorId

public java.lang.String getValidatorId()

setValidatorId

public void setValidatorId(java.lang.String validatorId)

getValidatorValueExpression

public Expressions.ValueExpression getValidatorValueExpression()

setValidatorValueExpression

public void setValidatorValueExpression(Expressions.ValueExpression validatorValueExpression)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

isValidateModel

public boolean isValidateModel()

setValidateModel

public void setValidateModel(boolean validateModel)