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

Class AmetysUserDataSource

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

All Implemented Interfaces:

UserDataSource, LogEnabled, PluginAware, Configurable, Serviceable

public class AmetysUserDataSource
extends AbstractStaticUserDataSource

Class for the ametys user data source

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,ModelItem>	_ametysUserDataSourceModelItems	Map of ModelItems specific to the AmetysUserDataSource
protected UserManager	_userManager	The users manager
static final String	ATTRIBUTE_USER_INFO	The user info attribute
static final String	EMAIL_USER_VALUE	Name of email userInfoStaticEnumerator entry
static final String	FIRSTNAME_USER_VALUE	Name of firstName userInfoStaticEnumerator entry
static final String	FULLNAME_USER_VALUE	Name of fullname userInfoStaticEnumerator entry
static final String	ID_USER_VALUE	Name of id userInfoStaticEnumerator entry
static final String	LASTNAME_USER_VALUE	Name of lastName userInfoStaticEnumerator entry

Fields inherited from class org.ametys.plugins.forms.question.computing.user.AbstractStaticUserDataSource

_description, _formElementDefinitionHelper, _id, _label, _pluginName

Constructor Summary

Constructors

Constructor	Description
AmetysUserDataSource()

Method Summary

Modifier and Type	Method	Description
protected String	_getUserInfoValue(FormQuestion question, User user)	Get user value
List<String>	getFieldToDisableIfFormPublished(FormQuestion question)	Get field to disable if form is published
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
String	getValue(FormQuestion question, UserIdentity currentUser)	Get the user data source value
List<ViewItem>	getViewElements()	Get the view items for the main tab
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.forms.question.computing.user.AbstractStaticUserDataSource

configure, getDescription, getId, getLabel, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ATTRIBUTE_USER_INFO

public static final String ATTRIBUTE_USER_INFO

The user info attribute

See Also:

• Constant Field Values

EMAIL_USER_VALUE

public static final String EMAIL_USER_VALUE

Name of email userInfoStaticEnumerator entry

See Also:

• Constant Field Values

ID_USER_VALUE

public static final String ID_USER_VALUE

Name of id userInfoStaticEnumerator entry

See Also:

• Constant Field Values

FULLNAME_USER_VALUE

public static final String FULLNAME_USER_VALUE

Name of fullname userInfoStaticEnumerator entry

See Also:

• Constant Field Values

FIRSTNAME_USER_VALUE

public static final String FIRSTNAME_USER_VALUE

Name of firstName userInfoStaticEnumerator entry

See Also:

• Constant Field Values

LASTNAME_USER_VALUE

public static final String LASTNAME_USER_VALUE

Name of lastName userInfoStaticEnumerator entry

See Also:

• Constant Field Values

_ametysUserDataSourceModelItems

protected Map<String,ModelItem> _ametysUserDataSourceModelItems

Map of ModelItems specific to the AmetysUserDataSource

_userManager

protected UserManager _userManager

The users manager

Constructor Details

AmetysUserDataSource

public AmetysUserDataSource()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractStaticUserDataSource

Throws:

ServiceException

getValue

public String getValue(FormQuestion question,
 UserIdentity currentUser)

Description copied from interface: UserDataSource

Get the user data source value

Parameters:

question - the question

currentUser - the current user

Returns:

the user data source value.

_getUserInfoValue

protected String _getUserInfoValue(FormQuestion question,
 User user)

Get user value

Parameters:

question - the question

user - the user

Returns:

the user value.null if there is not user value

getStorageType

public String getStorageType(FormQuestion question)

Description copied from interface: UserDataSource

Get the storage type of the user data source value

Parameters:

question - the question

Returns:

the storage type for the question

getModelItems

public Map<String,ModelItem> getModelItems()

Description copied from interface: UserDataSource

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

public List<ViewItem> getViewElements()

Description copied from interface: UserDataSource

Get the view items for the main tab

Returns:

a list of view items

getFieldToDisableIfFormPublished

public List<String> getFieldToDisableIfFormPublished(FormQuestion question)

Description copied from interface: UserDataSource

Get field to disable if form is published

Specified by:

getFieldToDisableIfFormPublished in interface UserDataSource

Overrides:

getFieldToDisableIfFormPublished in class AbstractStaticUserDataSource

Parameters:

question - the question

Returns:

the list of field name