fr.paris.lutece.portal.business.user.attribute

Class AbstractAttribute

java.lang.Object

fr.paris.lutece.portal.business.user.attribute.AbstractAttribute

All Implemented Interfaces:

IAttribute

Direct Known Subclasses:

AttributeCheckBox, AttributeComboBox, AttributeImage, AttributeRadioButton, AttributeText

public abstract class AbstractAttribute
extends Object
implements IAttribute

Attribute

Constructor Summary

Constructors

Constructor and Description
AbstractAttribute() Constructor

Method Summary

Modifier and Type	Method and Description
boolean	getAnonymize() Get the anonymize status of the attribute
AttributeType	getAttributeType() Get attribute type
String	getHelpMessage() Get help Message
String	getHtmlFormAttribute(Locale locale) Get Html form
String	getHtmlFormAttribute(Locale locale, Object listDefaultValues) Get Html form
String	getHtmlFormSearchAttribute(AdminUserFieldFilter auFieldFilter, Locale locale) Get Html form
String	getHtmlValue(Locale locale, AdminUserField userField) Get Html value
int	getIdAttribute() Get ID Attribute
List<AttributeField>	getListAttributeFields() Get list fields
Plugin	getPlugin() Get plugin
int	getPosition() Get position
String	getTitle() Get title
boolean	isAttributeImage() Check if it is an attribute image
boolean	isFieldInLine() Check if the attribute is to be shown in line
boolean	isMandatory() Get Mandatory
boolean	isShownInResultList() Check if the attribute is shown in result list
boolean	isShownInSearch() Check if the attribute is shown in search
void	setAnonymize(boolean bAnonymize) Set the anonymize status of the attribute
void	setAttributeImage(boolean bIsAttributeImage) Set the attribute as an attribute image
void	setAttributeType(AttributeType attributeType) Set attribute Type
void	setFieldInLine(boolean bIsFieldInLine) Set isFieldInLine
void	setHelpMessage(String strHelpMessage) Set help message
void	setIdAttribute(int nIdAttribute) Set ID Attribute
void	setListAttributeFields(List<AttributeField> listAttributeFields) Set list fields
void	setMandatory(boolean bMandatory) Set mandatory
void	setPlugin(Plugin plugin) Set plugin
void	setPosition(int nPosition) Set position
void	setShownInResultList(boolean bIsShownInResultList) Set isShownInResultList
void	setShownInSearch(boolean bIsShownInSearch) Set isShownInSearch
void	setTitle(String strTitle) Set title

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.paris.lutece.portal.business.user.attribute.IAttribute

getPropertyCreatePageTitle, getPropertyModifyPageTitle, getTemplateCreateAttribute, getTemplateHtmlFormAttribute, getTemplateHtmlFormSearchAttribute, getTemplateHtmlValue, getTemplateModifyAttribute, getUserFieldsData, isAnonymizable, setAttributeData, setAttributeType

Constructor Detail

AbstractAttribute

public AbstractAttribute()

Constructor

Method Detail

getIdAttribute

public int getIdAttribute()

Get ID Attribute

Specified by:

getIdAttribute in interface IAttribute

Returns:

ID attribute

setIdAttribute

public void setIdAttribute(int nIdAttribute)

Set ID Attribute

Specified by:

setIdAttribute in interface IAttribute

Parameters:

nIdAttribute - ID Attribute

isMandatory

public boolean isMandatory()

Get Mandatory

Specified by:

isMandatory in interface IAttribute

Returns:

true if it's mandatory, false otherwise

setMandatory

public void setMandatory(boolean bMandatory)

Set mandatory

Specified by:

setMandatory in interface IAttribute

Parameters:

bMandatory - true if it's mandatory, false otherwise

getListAttributeFields

public List<AttributeField> getListAttributeFields()

Get list fields

Specified by:

getListAttributeFields in interface IAttribute

Returns:

list fields

setListAttributeFields

public void setListAttributeFields(List<AttributeField> listAttributeFields)

Set list fields

Specified by:

setListAttributeFields in interface IAttribute

Parameters:

listAttributeFields - list fields

getTitle

public String getTitle()

Get title

Specified by:

getTitle in interface IAttribute

Returns:

title

setTitle

public void setTitle(String strTitle)

Set title

Specified by:

setTitle in interface IAttribute

Parameters:

strTitle - title

getHelpMessage

public String getHelpMessage()

Get help Message

Specified by:

getHelpMessage in interface IAttribute

Returns:

help message

setHelpMessage

public void setHelpMessage(String strHelpMessage)

Set help message

Specified by:

setHelpMessage in interface IAttribute

Parameters:

strHelpMessage - help message

getPosition

public int getPosition()

Get position

Specified by:

getPosition in interface IAttribute

Returns:

position

setPosition

public void setPosition(int nPosition)

Set position

Specified by:

setPosition in interface IAttribute

Parameters:

nPosition - position

getAttributeType

public AttributeType getAttributeType()

Get attribute type

Specified by:

getAttributeType in interface IAttribute

Returns:

attribute type

setAttributeType

public void setAttributeType(AttributeType attributeType)

Set attribute Type

Specified by:

setAttributeType in interface IAttribute

Parameters:

attributeType - attribute type

getAnonymize

public boolean getAnonymize()

Get the anonymize status of the attribute

Specified by:

getAnonymize in interface IAttribute

Returns:

True if the attribute should be anonymize, false otherwise.

setAnonymize

public void setAnonymize(boolean bAnonymize)

Set the anonymize status of the attribute

Specified by:

setAnonymize in interface IAttribute

Parameters:

bAnonymize - New anonymize status. True if the attribute should be anonymize, false otherwise.

getHtmlFormAttribute

public String getHtmlFormAttribute(Locale locale)

Get Html form

Parameters:

locale - locale

Returns:

html form

getHtmlFormAttribute

public String getHtmlFormAttribute(Locale locale,
                                   Object listDefaultValues)

Get Html form

Parameters:

locale - locale

listDefaultValues - the list of default values

Returns:

html form

getHtmlFormSearchAttribute

public String getHtmlFormSearchAttribute(AdminUserFieldFilter auFieldFilter,
                                         Locale locale)

Get Html form

Parameters:

auFieldFilter - The admin user field filter

locale - locale

Returns:

html form

getHtmlValue

public String getHtmlValue(Locale locale,
                           AdminUserField userField)

Get Html value

Parameters:

locale - Locale

userField - User field

Returns:

the html

getPlugin

public Plugin getPlugin()

Get plugin

Specified by:

getPlugin in interface IAttribute

Returns:

plugin

setPlugin

public void setPlugin(Plugin plugin)

Set plugin

Specified by:

setPlugin in interface IAttribute

Parameters:

plugin - plugin

isShownInSearch

public boolean isShownInSearch()

Check if the attribute is shown in search

Specified by:

isShownInSearch in interface IAttribute

Returns:

true if it is, false otherwise

setShownInSearch

public void setShownInSearch(boolean bIsShownInSearch)

Set isShownInSearch

Specified by:

setShownInSearch in interface IAttribute

Parameters:

bIsShownInSearch - shown in search

isFieldInLine

public boolean isFieldInLine()

Check if the attribute is to be shown in line

Specified by:

isFieldInLine in interface IAttribute

Returns:

true if it is shown in line, false otherwise

setFieldInLine

public void setFieldInLine(boolean bIsFieldInLine)

Set isFieldInLine

Specified by:

setFieldInLine in interface IAttribute

Parameters:

bIsFieldInLine - shown in line

isAttributeImage

public boolean isAttributeImage()

Check if it is an attribute image

Specified by:

isAttributeImage in interface IAttribute

Returns:

true if it is, false otherwise

setAttributeImage

public void setAttributeImage(boolean bIsAttributeImage)

Set the attribute as an attribute image

Specified by:

setAttributeImage in interface IAttribute

Parameters:

bIsAttributeImage - true if it is an image, false otherwise

isShownInResultList

public boolean isShownInResultList()

Check if the attribute is shown in result list

Specified by:

isShownInResultList in interface IAttribute

Returns:

true if it is, false otherwise

setShownInResultList

public void setShownInResultList(boolean bIsShownInResultList)

Set isShownInResultList

Specified by:

setShownInResultList in interface IAttribute

Parameters:

bIsShownInResultList - shown in result list