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

Class UserComputingType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.question.computing.AbstractStaticComputingType

org.ametys.plugins.forms.question.computing.UserComputingType

All Implemented Interfaces:

ComputingType, LogEnabled, PluginAware, Configurable, Serviceable

public class UserComputingType
extends AbstractStaticComputingType

Class for creating user computed field

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected Map<String,ModelItem>	_userComputingItems	Map of ModelItems specific to ManualSourceType
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.AbstractStaticComputingType

_choiceSourceTypeExtensionPoint, _computingTypeExtensionPoint, _description, _formQuestionDataTypeExtensionPoint, _id, _label, _pluginName, _xslt

Constructor Summary

Constructors

Constructor	Description
UserComputingType()

Method Summary

Modifier and Type	Method	Description
protected String	_getUserInfoValue(FormQuestion question, User user)	Get user value
boolean	canEdit()	true if the question can be edited after submission
String	getComputedValue(FormQuestion computedQuestion, FormEntry entry)	Get the computed value for the field
List<String>	getFieldToDisableIfFormPublished()	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 question type
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.AbstractStaticComputingType

configure, getDescription, getId, getJSRenderer, getLabel, getXSLT, hasComputedValue, saxAdditionalValue, 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

Methods inherited from interface org.ametys.plugins.forms.question.computing.ComputingType

isCacheable, valueToJSONForClient

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

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_userManager

protected UserManager _userManager

The users manager

_userComputingItems

protected Map<String,ModelItem> _userComputingItems

Map of ModelItems specific to ManualSourceType

Constructor Details

UserComputingType

public UserComputingType()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractStaticComputingType

Throws:

ServiceException

getComputedValue

public String getComputedValue(FormQuestion computedQuestion,
 FormEntry entry)

Description copied from interface: ComputingType

Get the computed value for the field

Parameters:

computedQuestion - the question

entry - the entry

Returns:

the computed value

getModelItems

public Map<String,ModelItem> getModelItems()

Description copied from interface: ComputingType

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

Returns:

a map of the model items

getViewElements

public List<ViewItem> getViewElements()

Description copied from interface: ComputingType

Get the view items for the main tab

Returns:

a list of view items

_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: ComputingType

Get the storage type of the question type

Parameters:

question - the question

Returns:

the storage type

getFieldToDisableIfFormPublished

public List<String> getFieldToDisableIfFormPublished()

Description copied from interface: ComputingType

Get field to disable if form is published

Specified by:

getFieldToDisableIfFormPublished in interface ComputingType

Overrides:

getFieldToDisableIfFormPublished in class AbstractStaticComputingType

Returns:

the list of field name

canEdit

public boolean canEdit()

Description copied from interface: ComputingType

true if the question can be edited after submission

Returns:

true if the question can be edited after submission