org.jasig.portlet.proxy.service

Interface IFormField

All Known Implementing Classes:

FormFieldImpl

public interface IFormField

IFormField is an interface used to store form field information within an IContentRequest object. The name getter/setter refer to the HTML input field name. The value getter/setter refer to the value of the HTML input field name. The value can contain either a static value or a value that will be substituted through a properly configured IPreInterceptor class. The secured getter/setter refers to whether the field needs to be encrypted in the database and displayed as a password instead of a text html input field.

Author:

mgillian

Method Summary

Modifier and Type	Method and Description
IFormField	duplicate() duplicate() copies the data from the current IFormField into the passed-in parameter
String	getName() getName() gets the name of the field (name used in form submission)
boolean	getSecured() getSecured() returns whether the field is encrypted and should be displayed obscured to the user
String	getValue() getValue() returns the first value associated with the Field
String[]	getValues() getValues() gets the values of the field
void	setName(String name) setName() sets the name of the field (name used in form submission)
void	setSecured(boolean isSecured) setSecured(boolean) changes whether the field should be encrypted and obscured
void	setValue(String value) setValue() sets the first value of the field
void	setValues(String[] values) setValues() sets the values of the field

Method Detail

setName

void setName(String name)

setName() sets the name of the field (name used in form submission)

Parameters:

name -

getName

String getName()

getName() gets the name of the field (name used in form submission)

Returns:

setValue

void setValue(String value)

setValue() sets the first value of the field

Parameters:

value -

setValues

void setValues(String[] values)

setValues() sets the values of the field

Parameters:

values -

getValue

String getValue()

getValue() returns the first value associated with the Field

Returns:

getValues

String[] getValues()

getValues() gets the values of the field

Returns:

getSecured

boolean getSecured()

getSecured() returns whether the field is encrypted and should be displayed obscured to the user

Returns:

true if field should be encrypted and secured, false otherwise

setSecured

void setSecured(boolean isSecured)

setSecured(boolean) changes whether the field should be encrypted and obscured

Parameters:

isSecured -

duplicate

IFormField duplicate()

duplicate() copies the data from the current IFormField into the passed-in parameter