fr.paris.lutece.plugins.document.service

Interface AttributeManager

All Known Implementing Classes:

DateManager, DefaultManager, FileManager, ImageFileManager, InternalLinkManager, ListBoxManager, MultilineManager, NumerictextManager, RichTextManager, TextManager, UrlManager

public interface AttributeManager

Define the interface for attribute's specific behavior

Method Summary

Modifier and Type	Method and Description
boolean	canBeUsedAsThumbnail() Tells if the attrubute can be used as Thumbnail (image)
String	getAttributeTypeCode() Return the attribute Type code
String	getAttributeXmlValue(Document document, DocumentAttribute attribute) Get the XML data corresponding to the attribute to build the docuemnt XML content
String	getCreateFormHtml(DocumentAttribute attribute, Locale locale, String strBaseUrl) Gets the part of an HTML form to enter attribute data
String	getCreateParametersFormHtml(List<AttributeTypeParameter> listParameters, Locale locale) Gets the part of an HTML form to enter parameters data
String	getCreateParametersFormHtml(Locale locale) Gets the part of an HTML form to enter parameters data
List<AttributeTypeParameter>	getExtraParameters(Locale locale) Gets extra parameters for the attribute
List<AttributeTypeParameter>	getExtraParametersValues(Locale locale, int nAttributeId) Gets extra parameters values for the attribute
String	getModifyFormHtml(DocumentAttribute attribute, Document document, Locale locale, String strBaseUrl) Gets the part of an HTML form to modify attribute data
String	getModifyParametersFormHtml(Locale locale, int nAttributeId) Gets the part of an HTML form to modify parameters data
List<AttributeTypeParameter>	getValueParameters(javax.servlet.http.HttpServletRequest request, Locale locale) Get the value parameters
void	setAttributeTypeCode(String strCode) Define the attribute Type code
String	validateValue(int nAttributeId, String strValue, Locale locale) Validate the value for the attribute
String	validateValueParameters(List<AttributeTypeParameter> listParameters, Locale locale) Validate the value for the parameters

Method Detail

setAttributeTypeCode

void setAttributeTypeCode(String strCode)

Define the attribute Type code

Parameters:

strCode - The Attribute Type Code

getAttributeTypeCode

String getAttributeTypeCode()

Return the attribute Type code

Returns:

The Attribute Type Code

getCreateFormHtml

String getCreateFormHtml(DocumentAttribute attribute,
                         Locale locale,
                         String strBaseUrl)

Gets the part of an HTML form to enter attribute data

Parameters:

attribute - The attribute

locale - The current Locale

strBaseUrl - the base url

Returns:

A part of the HTML form

getModifyFormHtml

String getModifyFormHtml(DocumentAttribute attribute,
                         Document document,
                         Locale locale,
                         String strBaseUrl)

Gets the part of an HTML form to modify attribute data

Parameters:

attribute - The attribute

document - The attribute document

locale - The current Locale

strBaseUrl - The base url

Returns:

A part of the HTML form

getCreateParametersFormHtml

String getCreateParametersFormHtml(Locale locale)

Gets the part of an HTML form to enter parameters data

Parameters:

locale - The current Locale

Returns:

A part of the HTML form

getCreateParametersFormHtml

String getCreateParametersFormHtml(List<AttributeTypeParameter> listParameters,
                                   Locale locale)

Gets the part of an HTML form to enter parameters data

Parameters:

listParameters - list attribute type parameters

locale - The current Locale

Returns:

A part of the HTML form

getModifyParametersFormHtml

String getModifyParametersFormHtml(Locale locale,
                                   int nAttributeId)

Gets the part of an HTML form to modify parameters data

Parameters:

locale - The current Locale

nAttributeId - Attribute Id

Returns:

A part of the HTML form

getExtraParameters

List<AttributeTypeParameter> getExtraParameters(Locale locale)

Gets extra parameters for the attribute

Parameters:

locale - The current Locale

Returns:

A collection of attribute parameters

getExtraParametersValues

List<AttributeTypeParameter> getExtraParametersValues(Locale locale,
                                                      int nAttributeId)

Gets extra parameters values for the attribute

Parameters:

locale - The current Locale

nAttributeId -

Returns:

The extra parameters values for the attribute

validateValue

String validateValue(int nAttributeId,
                     String strValue,
                     Locale locale)

Validate the value for the attribute

Parameters:

nAttributeId - The attribute identifier

strValue - The value to check

locale - The current Locale

Returns:

null if valid, otherwise error message

validateValueParameters

String validateValueParameters(List<AttributeTypeParameter> listParameters,
                               Locale locale)

Validate the value for the parameters

Parameters:

listParameters - The list of parameters to check

locale - The locale

Returns:

null if valid, otherwise message property

getAttributeXmlValue

String getAttributeXmlValue(Document document,
                            DocumentAttribute attribute)

Get the XML data corresponding to the attribute to build the docuemnt XML content

Parameters:

document - The document

attribute - The attribute

Returns:

The XML value of the attribute

canBeUsedAsThumbnail

boolean canBeUsedAsThumbnail()

Tells if the attrubute can be used as Thumbnail (image)

Returns:

true if the attrubute can be used as Thumbnail, otherwise false

getValueParameters

List<AttributeTypeParameter> getValueParameters(javax.servlet.http.HttpServletRequest request,
                                                Locale locale)

Get the value parameters

Parameters:

request - the HTTP request

locale - the locale

Returns:

a list of AttributeTypeParameter