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

All Known Implementing Classes:
AbstractAttribute, AttributeCheckBox, AttributeComboBox, AttributeImage, AttributeRadioButton, AttributeText

public interface IAttribute

IAttribute


Method Summary
 AttributeType getAttributeType()
          Get attribute type
 java.lang.String getHelpMessage()
          Get help Message
 int getIdAttribute()
          Get ID Attribute
 java.util.List<AttributeField> getListAttributeFields()
          Get list fields
 Plugin getPlugin()
          Get plugin
 int getPosition()
          Get position
 java.lang.String getPropertyCreatePageTitle()
          Get page title for create page
 java.lang.String getPropertyModifyPageTitle()
          Get page title for modify page
 java.lang.String getTemplateCreateAttribute()
          Get the template create an attribute
 java.lang.String getTemplateHtmlFormAttribute()
          Get the template html form attribute
 java.lang.String getTemplateHtmlFormSearchAttribute()
          Get the template html form search attribute
 java.lang.String getTemplateHtmlValue()
          Get the template html for the value of the attribute
 java.lang.String getTemplateModifyAttribute()
          Get the template modify an attribute
 java.lang.String getTitle()
          Get title
 java.util.List<AdminUserField> getUserFieldsData(javax.servlet.http.HttpServletRequest request, AdminUser user)
          Get the data of the user fields
 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
 java.lang.String setAttributeData(javax.servlet.http.HttpServletRequest request)
          Set the data of the attribute
 void setAttributeImage(boolean bIsAttributeImage)
          Set the attribute as an attribute image
 void setAttributeType(AttributeType attributeType)
          Set attribute Type
 void setAttributeType(java.util.Locale locale)
          Set attribute type
 void setFieldInLine(boolean bIsFieldInLine)
          Set isFieldInLine
 void setHelpMessage(java.lang.String strHelpMessage)
          Set help message
 void setIdAttribute(int nIdAttribute)
          Set ID Attribute
 void setListAttributeFields(java.util.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(java.lang.String strTitle)
          Set title
 

Method Detail

getIdAttribute

int getIdAttribute()
Get ID Attribute

Returns:
ID attribute

setIdAttribute

void setIdAttribute(int nIdAttribute)
Set ID Attribute

Parameters:
nIdAttribute - ID Attribute

isMandatory

boolean isMandatory()
Get Mandatory

Returns:
true if it's mandatory, false otherwise

setMandatory

void setMandatory(boolean bMandatory)
Set mandatory

Parameters:
bMandatory - true if it's mandatory, false otherwise

getListAttributeFields

java.util.List<AttributeField> getListAttributeFields()
Get list fields

Returns:
list fields

setListAttributeFields

void setListAttributeFields(java.util.List<AttributeField> listAttributeFields)
Set list fields

Parameters:
listAttributeFields - list fields

getTitle

java.lang.String getTitle()
Get title

Returns:
title

setTitle

void setTitle(java.lang.String strTitle)
Set title

Parameters:
strTitle - title

getHelpMessage

java.lang.String getHelpMessage()
Get help Message

Returns:
help message

setHelpMessage

void setHelpMessage(java.lang.String strHelpMessage)
Set help message

Parameters:
strHelpMessage - help message

getPosition

int getPosition()
Get position

Returns:
position

setPosition

void setPosition(int nPosition)
Set position

Parameters:
nPosition - position

getAttributeType

AttributeType getAttributeType()
Get attribute type

Returns:
attribute type

setAttributeType

void setAttributeType(AttributeType attributeType)
Set attribute Type

Parameters:
attributeType - attribute type

getPlugin

Plugin getPlugin()
Get plugin

Returns:
plugin

setPlugin

void setPlugin(Plugin plugin)
Set plugin

Parameters:
plugin - plugin

isShownInSearch

boolean isShownInSearch()
Check if the attribute is shown in search

Returns:
true if it is, false otherwise

setShownInSearch

void setShownInSearch(boolean bIsShownInSearch)
Set isShownInSearch

Parameters:
bIsShownInSearch - shown in search

isShownInResultList

boolean isShownInResultList()
Check if the attribute is shown in result list

Returns:
true if it is, false otherwise

setShownInResultList

void setShownInResultList(boolean bIsShownInResultList)
Set isShownInResultList

Parameters:
bIsShownInResultList - shown in result list

isFieldInLine

boolean isFieldInLine()
Check if the attribute is to be shown in line

Returns:
true if it is shown in line, false otherwise

setFieldInLine

void setFieldInLine(boolean bIsFieldInLine)
Set isFieldInLine

Parameters:
bIsFieldInLine - shown in line

getUserFieldsData

java.util.List<AdminUserField> getUserFieldsData(javax.servlet.http.HttpServletRequest request,
                                                 AdminUser user)
Get the data of the user fields

Parameters:
request - HttpServletRequest
user - user
Returns:
user field data

setAttributeType

void setAttributeType(java.util.Locale locale)
Set attribute type

Parameters:
locale - locale

getPropertyCreatePageTitle

java.lang.String getPropertyCreatePageTitle()
Get page title for create page

Returns:
page title

getPropertyModifyPageTitle

java.lang.String getPropertyModifyPageTitle()
Get page title for modify page

Returns:
page title

getTemplateCreateAttribute

java.lang.String getTemplateCreateAttribute()
Get the template create an attribute

Returns:
The URL of the template

getTemplateModifyAttribute

java.lang.String getTemplateModifyAttribute()
Get the template modify an attribute

Returns:
The URL of the template

getTemplateHtmlFormAttribute

java.lang.String getTemplateHtmlFormAttribute()
Get the template html form attribute

Returns:
the template

getTemplateHtmlFormSearchAttribute

java.lang.String getTemplateHtmlFormSearchAttribute()
Get the template html form search attribute

Returns:
the template

getTemplateHtmlValue

java.lang.String getTemplateHtmlValue()
Get the template html for the value of the attribute

Returns:
the template

setAttributeData

java.lang.String setAttributeData(javax.servlet.http.HttpServletRequest request)
Set the data of the attribute

Parameters:
request - HttpServletRequest
Returns:
null if there are no errors

isAttributeImage

boolean isAttributeImage()
Check if it is an attribute image

Returns:
true if it is, false otherwise

setAttributeImage

void setAttributeImage(boolean bIsAttributeImage)
Set the attribute as an attribute image

Parameters:
bIsAttributeImage - true if it is an image, false otherwise


Copyright © 2012 Mairie de Paris. All Rights Reserved.