lumis.service.formbuilder

Class FormField

java.lang.Object

lumis.service.formbuilder.FormField

public class FormField
extends Object

Form Builder fields

Since:

8.2.0

Version:

$Revision: 23035 $ $Date: 2019-08-05 19:55:10 +0000 (Mon, 05 Aug 2019) $

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMED_QUERY_GET_FIELD_BY_FIELDID_AND_FORM_ID

Constructor Summary

Constructors

Constructor and Description
FormField()

Method Summary

Modifier and Type	Method and Description
String	getAdditionalText() Returns the additional text
String	getFieldId() Returns the field identifier.
String	getFormId() Returns the Form this FormField belongs to.
String	getHelpText() Returns the help text.
String	getId() Returns the FormField identifier.
List<lumis.service.formbuilder.FormFieldOption>	getOptions() Returns the options for this field.
int	getPosition() Returns the display position of the FormField.
String	getTitle() Returns the title.
FormFieldType	getType() Returns the type.
boolean	isRequired() Returns if the user is required to answer the FormField.
void	setAdditionalText(String additionalText) Sets the additional text
void	setFieldId(String fieldId) Sets the field identifier.
void	setFormId(String form) Sets the Form this FormField belongs to.
void	setHelpText(String helpText) Sets the help text
void	setId(String id) Sets the FormField identifier.
void	setOptions(List<lumis.service.formbuilder.FormFieldOption> options)
void	setPosition(int position) Sets the display position of the FormField.
void	setRequired(boolean required) Sets if the user is required to answer the FormField.
void	setTitle(String title) Sets the title.
void	setType(FormFieldType type) Sets the type.

Methods inherited from class java.lang.Object

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

Field Detail

NAMED_QUERY_GET_FIELD_BY_FIELDID_AND_FORM_ID

public static final String NAMED_QUERY_GET_FIELD_BY_FIELDID_AND_FORM_ID

See Also:

Constant Field Values

Constructor Detail

FormField

public FormField()

Method Detail

getId

public String getId()

Returns the FormField identifier.

Returns:

the identifier

Since:

8.2.0

setId

public void setId(String id)

Sets the FormField identifier.

Parameters:

id - the identifier value to set.

Since:

8.2.0

getFormId

public String getFormId()

Returns the Form this FormField belongs to.

Returns:

the Form

Since:

8.2.0

setFormId

public void setFormId(String form)

Sets the Form this FormField belongs to.

Parameters:

form - the Form

Since:

8.2.0

getPosition

public int getPosition()

Returns the display position of the FormField.

Returns:

the position

Since:

8.2.0

setPosition

public void setPosition(int position)

Sets the display position of the FormField.

Parameters:

position - the position value to set.

Since:

8.2.0

isRequired

public boolean isRequired()

Returns if the user is required to answer the FormField.

Returns:

the required

Since:

8.2.0

setRequired

public void setRequired(boolean required)

Sets if the user is required to answer the FormField.

Parameters:

required - the required value to set.

Since:

8.2.0

getTitle

public String getTitle()

Returns the title.

Returns:

the title

Since:

8.2.0

setTitle

public void setTitle(String title)

Sets the title.

Parameters:

title - the title value to set.

Since:

8.2.0

getFieldId

public String getFieldId()

Returns the field identifier.

Returns:

the field identifier

Since:

8.2.0

setFieldId

public void setFieldId(String fieldId)

Sets the field identifier.

Parameters:

fieldId - the field identifier value to set.

Since:

8.2.0

getType

public FormFieldType getType()

Returns the type.

Returns:

the type

Since:

8.2.0

setType

public void setType(FormFieldType type)

Sets the type.

Parameters:

type - the type value to set.

Since:

8.2.0

getOptions

public List<lumis.service.formbuilder.FormFieldOption> getOptions()

Returns the options for this field.

The returned list is detached from this entity and any modification on it will not be applied automatically. To modify the options of this field use setOptions(List).

Returns:

the options for this field, or null if this field has no option.

Since:

9.0.0

setOptions

public void setOptions(List<lumis.service.formbuilder.FormFieldOption> options)

getHelpText

public String getHelpText()

Returns the help text.

Returns:

the help text.

Since:

11.2.0

setHelpText

public void setHelpText(String helpText)

Sets the help text

Parameters:

helpText - the help text to set

Since:

11.2.0

getAdditionalText

public String getAdditionalText()

Returns the additional text

Returns:

the additional text

Since:

11.2.0

setAdditionalText

public void setAdditionalText(String additionalText)

Sets the additional text

Parameters:

additionalText - the additional text to set

Since:

11.2.0