fr.paris.lutece.plugins.form.business
Interface IEntry

All Known Implementing Classes:
Entry, EntryTypeCheckBox, EntryTypeComment, EntryTypeDate, EntryTypeFile, EntryTypeGroup, EntryTypeRadioButton, EntryTypeSelect, EntryTypeSelectSQL, EntryTypeText, EntryTypeTextArea

public interface IEntry

IEntry Class


Method Summary
 java.util.List<IEntry> getChildren()
           
 java.lang.String getComment()
           
 java.lang.String getConfirmFieldTitle()
          Get the title of the confirmation field
 EntryType getEntryType()
           
 Field getFieldDepend()
           
 java.util.List<Field> getFields()
           
 Form getForm()
           
 java.lang.String getHelpMessage()
           
 java.lang.String getHtmlCode()
          Get the HtmlCode of the entry
 int getIdEntry()
           
 int getNumberConditionalQuestion()
           
 fr.paris.lutece.util.html.Paginator getPaginator(int nItemPerPage, java.lang.String strBaseUrl, java.lang.String strPageIndexParameterName, java.lang.String strPageIndex)
          The paginator who is use in the template modify of the entry
 IEntry getParent()
           
 int getPosition()
           
 fr.paris.lutece.util.ReferenceList getReferenceListRegularExpression(IEntry entry, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the list of regular expression who is use in the template modify of the entry
 java.lang.String getRequestData(javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          Get the request data
 FormError getResponseData(javax.servlet.http.HttpServletRequest request, java.util.List<Response> listResponse, java.util.Locale locale)
          save in the list of response the response associate to the entry in the form submit
 java.lang.String getResponseValueForExport(javax.servlet.http.HttpServletRequest request, Response response, java.util.Locale locale)
          Get the response value associate to the entry to export in the file export
 java.lang.String getResponseValueForRecap(javax.servlet.http.HttpServletRequest request, Response response, java.util.Locale locale)
          Get the response value associate to the entry to write in the recap
 java.lang.String getTemplateCreate()
          Get template create url of the entry
 java.lang.String getTemplateModify()
          Get the template modify url of the entry
 java.lang.String getTitle()
           
 boolean isConfirmField()
           
 boolean isFieldInLine()
           
 boolean isFirstInTheList()
           
 boolean isLastInTheList()
           
 boolean isMandatory()
           
 boolean isUnique()
           
 void setChildren(java.util.List<IEntry> children)
          set the list of entry who are insert in the group
 void setComment(java.lang.String comment)
          set entry comment
 void setConfirmField(boolean bConfirmField)
          set true if the question must be confirmed by a duplicated field
 void setConfirmFieldTitle(java.lang.String strConfirmFieldTitle)
          Set the title of the confirmation field
 void setEntryType(EntryType entryType)
          set the type of the entry
 void setFieldDepend(Field field)
          set the field if the entry is a conditional question
 void setFieldInLine(boolean fieldInLine)
          set true if the field associate must be display in line
 void setFields(java.util.List<Field> fields)
          set the list of field who are associate to the entry
 void setFirstInTheList(boolean firstInTheList)
          set true if the entry is the first entry of a group or the list of entry
 void setForm(Form form)
          set the form of the entry
 void setHelpMessage(java.lang.String helpMessage)
          set the entry help message
 void setIdEntry(int idEntry)
          set the id of the entry
 void setLastInTheList(boolean lastInTheList)
          set true if the entry is the last entry of a group or the list of entry
 void setMandatory(boolean mandatory)
          set true if the question is mandatory
 void setNumberConditionalQuestion(int numberConditionalQuestion)
          set the number of conditional questions who are assocaite to the entry
 void setParent(IEntry parent)
          set parent entry if the entry is insert in a group
 void setPosition(int position)
          set position entry
 void setTitle(java.lang.String title)
          set title entry
 void setUnique(boolean bUnique)
          Set to true if the value of the response to this question must be unique
 

Method Detail

getIdEntry

int getIdEntry()
Returns:
the id of entry

getTitle

java.lang.String getTitle()
Returns:
title entry

getHelpMessage

java.lang.String getHelpMessage()
Returns:
the entry help message

getComment

java.lang.String getComment()
Returns:
the entry comment

isMandatory

boolean isMandatory()
Returns:
true if the question is mandatory

isConfirmField

boolean isConfirmField()
Returns:
true if the question must be confirmed by a duplicated field

isUnique

boolean isUnique()
Returns:
true if the value of the response to this question must be unique

getConfirmFieldTitle

java.lang.String getConfirmFieldTitle()
Get the title of the confirmation field

Returns:
The title of the confirmation field

isFieldInLine

boolean isFieldInLine()
Returns:
true if the field associate must be display in line

getPosition

int getPosition()
Returns:
position entry

getForm

Form getForm()
Returns:
the form of the entry

getEntryType

EntryType getEntryType()
Returns:
the type of the entry

getParent

IEntry getParent()
Returns:
parent entry if the entry is insert in a group

getChildren

java.util.List<IEntry> getChildren()
Returns:
the list of entry who are insert in the group

getFields

java.util.List<Field> getFields()
Returns:
the list of field who are associate to the entry

getFieldDepend

Field getFieldDepend()
Returns:
the field if the entry is a conditional question

getNumberConditionalQuestion

int getNumberConditionalQuestion()
Returns:
the number of conditional questions who are assocaite to the entry

getRequestData

java.lang.String getRequestData(javax.servlet.http.HttpServletRequest request,
                                java.util.Locale locale)
Get the request data

Parameters:
request - HttpRequest
locale - the locale
Returns:
null if all data requiered are in the request else the url of jsp error

getResponseData

FormError getResponseData(javax.servlet.http.HttpServletRequest request,
                          java.util.List<Response> listResponse,
                          java.util.Locale locale)
save in the list of response the response associate to the entry in the form submit

Parameters:
request - HttpRequest
listResponse - the list of response associate to the entry in the form submit
locale - the locale
Returns:
a Form error object if there is an error in the response

getHtmlCode

java.lang.String getHtmlCode()
Get the HtmlCode of the entry

Returns:
the HtmlCode of the entry

getTemplateCreate

java.lang.String getTemplateCreate()
Get template create url of the entry

Returns:
template create url of the entry

getTemplateModify

java.lang.String getTemplateModify()
Get the template modify url of the entry

Returns:
template modify url of the entry

getPaginator

fr.paris.lutece.util.html.Paginator getPaginator(int nItemPerPage,
                                                 java.lang.String strBaseUrl,
                                                 java.lang.String strPageIndexParameterName,
                                                 java.lang.String strPageIndex)
The paginator who is use in the template modify of the entry

Parameters:
nItemPerPage - Number of items to display per page
strBaseUrl - The base Url for build links on each page link
strPageIndexParameterName - The parameter name for the page index
strPageIndex - The current page index
Returns:
the paginator who is use in the template modify of the entry

getReferenceListRegularExpression

fr.paris.lutece.util.ReferenceList getReferenceListRegularExpression(IEntry entry,
                                                                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the list of regular expression who is use in the template modify of the entry

Parameters:
plugin - the plugin
entry - the entry
Returns:
the regular expression list who is use in the template modify of the entry

getResponseValueForExport

java.lang.String getResponseValueForExport(javax.servlet.http.HttpServletRequest request,
                                           Response response,
                                           java.util.Locale locale)
Get the response value associate to the entry to export in the file export

Parameters:
response - the response associate to the entry
locale - the locale
request - the request
Returns:
the response value associate to the entry to export in the file export

getResponseValueForRecap

java.lang.String getResponseValueForRecap(javax.servlet.http.HttpServletRequest request,
                                          Response response,
                                          java.util.Locale locale)
Get the response value associate to the entry to write in the recap

Parameters:
response - the response associate to the entry
locale - the locale
request - the request
Returns:
the response value associate to the entry to write in the recap

isLastInTheList

boolean isLastInTheList()
Returns:
true if the entry is the last entry of a group or the list of entry

isFirstInTheList

boolean isFirstInTheList()
Returns:
true if the entry is the first entry of a group or the list of entry

setIdEntry

void setIdEntry(int idEntry)
set the id of the entry

Parameters:
idEntry - the id of the entry

setTitle

void setTitle(java.lang.String title)
set title entry

Parameters:
title - title

setHelpMessage

void setHelpMessage(java.lang.String helpMessage)
set the entry help message

Parameters:
helpMessage - the entry help message

setComment

void setComment(java.lang.String comment)
set entry comment

Parameters:
comment - entry comment

setMandatory

void setMandatory(boolean mandatory)
set true if the question is mandatory

Parameters:
mandatory - true if the question is mandatory

setFieldInLine

void setFieldInLine(boolean fieldInLine)
set true if the field associate must be display in line

Parameters:
fieldInLine - true if the field associate must be display in line

setPosition

void setPosition(int position)
set position entry

Parameters:
position - position entry

setForm

void setForm(Form form)
set the form of the entry

Parameters:
form - the form of the entry

setEntryType

void setEntryType(EntryType entryType)
set the type of the entry

Parameters:
entryType - the type of the entry

setParent

void setParent(IEntry parent)
set parent entry if the entry is insert in a group

Parameters:
parent - parent entry

setChildren

void setChildren(java.util.List<IEntry> children)
set the list of entry who are insert in the group

Parameters:
children - the list of entry

setFields

void setFields(java.util.List<Field> fields)
set the list of field who are associate to the entry

Parameters:
fields - the list of field

setFieldDepend

void setFieldDepend(Field field)
set the field if the entry is a conditional question

Parameters:
field - depend the field if the entry is a conditional question

setNumberConditionalQuestion

void setNumberConditionalQuestion(int numberConditionalQuestion)
set the number of conditional questions who are assocaite to the entry

Parameters:
numberConditionalQuestion - the number of conditional questions who are assocaite to the entry

setLastInTheList

void setLastInTheList(boolean lastInTheList)
set true if the entry is the last entry of a group or the list of entry

Parameters:
lastInTheList - true if the entry is the last entry of a group or the list of entry

setFirstInTheList

void setFirstInTheList(boolean firstInTheList)
set true if the entry is the first entry of a group or the list of entry

Parameters:
firstInTheList - true if the entry is the last entry of a group or the list of entry

setConfirmField

void setConfirmField(boolean bConfirmField)
set true if the question must be confirmed by a duplicated field

Parameters:
mandatory - true if the question must be confirmed by a duplicated field

setConfirmFieldTitle

void setConfirmFieldTitle(java.lang.String strConfirmFieldTitle)
Set the title of the confirmation field

Parameters:
strConfirmFieldTitle -

setUnique

void setUnique(boolean bUnique)
Set to true if the value of the response to this question must be unique



Copyright © 2011 Mairie de Paris. All Rights Reserved.