Package org.ametys.plugins.forms.question.autofill

Interface AutofillSource

All Known Implementing Classes:

AbstractStaticAutoFillSource, CurrentUserAutoFillSource, CustomValueAutoFillSource, UDUserAutoFillSource

public interface AutofillSource

Interface for creating a new source for autofill in text fields

Method Summary

Modifier and Type	Method	Description
String	getAutofillValue(FormQuestion question)	Get autofill value
I18nizableText	getDescription()	Get description of autofill source
String	getId()	Get id of the autofill source
I18nizableText	getLabel()	Get label of autofill source
Map<String,ModelItem>	getModelItems()	Get the type model items If the return value is null there won't be any processing on the server side
List<ViewItem>	getViewElements()	Get the view items for the main tab
boolean	isCacheable(FormQuestion question)	Return true if the question can be cacheable with this source.
void	saxAdditionalInfos(ContentHandler contentHandler, FormQuestion question)	Sax additional infos

Method Details

getId

String getId()

Get id of the autofill source

Returns:

the id

getLabel

I18nizableText getLabel()

Get label of autofill source

Returns:

the label

getDescription

I18nizableText getDescription()

Get description of autofill source

Returns:

the description

getAutofillValue

String getAutofillValue(FormQuestion question)

Get autofill value

Parameters:

question - the question

Returns:

the autofill value.

getModelItems

Map<String,ModelItem> getModelItems()

Get the type model items If the return value is null there won't be any processing on the server side

Returns:

a list of the model items

getViewElements

List<ViewItem> getViewElements()

Get the view items for the main tab

Returns:

a list of view items

saxAdditionalInfos

void saxAdditionalInfos(ContentHandler contentHandler,
 FormQuestion question)
                 throws SAXException

Sax additional infos

Parameters:

contentHandler - the content handler

question - the question

Throws:

SAXException - if an error occurred

isCacheable

boolean isCacheable(FormQuestion question)

Return true if the question can be cacheable with this source.

Parameters:

question - the question

Returns:

true if the question can be cacheable.