Package org.ametys.plugins.forms.question.computing.user

Interface UserDataSource

All Known Implementing Classes:

AbstractStaticUserDataSource, AmetysUserDataSource, UDUserDataSource

public interface UserDataSource

Interface for creating a user data source for UserDataComputingType

Method Summary

Modifier and Type	Method	Description
I18nizableText	getDescription()	Get description of the user data source
List<String>	getFieldToDisableIfFormPublished(FormQuestion question)	Get field to disable if form is published
String	getId()	Get id of the user data source
I18nizableText	getLabel()	Get label of the user data 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
String	getStorageType(FormQuestion question)	Get the storage type of the user data source value
Object	getValue(FormQuestion question, UserIdentity currentUser)	Get the user data source value
List<ViewItem>	getViewElements()	Get the view items for the main tab

Method Details

getId

String getId()

Get id of the user data source

Returns:

the id

getLabel

I18nizableText getLabel()

Get label of the user data source

Returns:

the label

getDescription

I18nizableText getDescription()

Get description of the user data source

Returns:

the description

getValue

Object getValue(FormQuestion question,
 UserIdentity currentUser)

Get the user data source value

Parameters:

question - the question

currentUser - the current user

Returns:

the user data source value.

getStorageType

String getStorageType(FormQuestion question)

Get the storage type of the user data source value

Parameters:

question - the question

Returns:

the storage type for the question

getFieldToDisableIfFormPublished

List<String> getFieldToDisableIfFormPublished(FormQuestion question)

Get field to disable if form is published

Parameters:

question - the question

Returns:

the list of field name

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