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

All Known Implementing Classes:
Entry, EntryTypeCheckBox, EntryTypeComment, EntryTypeDate, EntryTypeDirectory, EntryTypeFile, EntryTypeGeolocation, EntryTypeGroup, EntryTypeImg, EntryTypeInternalLink, EntryTypeMail, EntryTypeNumbering, EntryTypeRadioButton, EntryTypeRichText, EntryTypeSelect, EntryTypeSQL, EntryTypeText, EntryTypeTextArea, EntryTypeUrl

public interface IEntry

IEntry Class


Method Summary
 void addSearchCriteria(java.util.HashMap<java.lang.String,java.lang.Object> mapSearchItem, RecordField recordField)
          add in the search map the criteria
 java.lang.String convertRecordFieldTitleToString(RecordField recordField, java.util.Locale locale, boolean bDisplayFront)
          convert the title contains in the record field to string
 java.lang.String convertRecordFieldValueToString(RecordField recordField, java.util.Locale locale, boolean bDisplayFront, boolean bDisplayExport)
          convert the value contains in the record field to string
 java.util.List<IEntry> getChildren()
           
 java.lang.String getComment()
           
 Directory getDirectory()
           
 int getDisplayHeight()
           
 int getDisplayWidth()
           
 int getEntryAssociate()
           
 java.lang.String getEntryData(javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          Get the request data
 EntryType getEntryType()
           
 java.util.List<Field> getFields()
           
 java.lang.String getHelpMessage()
           
 java.lang.String getHelpMessageSearch()
           
 java.lang.String getHtmlFormEntry(java.util.Locale locale, boolean isDisplayFront)
          Get Html code used in entry form
 java.lang.String getHtmlFormEntry(java.util.Locale locale, java.util.List<RecordField> listRecordField, boolean isDisplayFront)
          Get Html code used in entry form
 java.lang.String getHtmlFormSearchEntry(java.util.Locale locale, boolean isDisplayFront)
          Get Html code used in search form
 java.lang.String getHtmlFormSearchEntry(java.util.Locale locale, java.util.List<RecordField> listRecordField, boolean isDisplayFront)
          Get Html code used in search form
 java.lang.String getHtmlRecordFieldValue(java.util.Locale locale, RecordField recordField, boolean isDisplayFront)
          Get the Html code used in display records
 int getIdEntry()
           
 void getImportRecordFieldData(Record record, byte[] decodedBytes, java.lang.String nomFile, boolean b, java.util.List<RecordField> listRecordField, java.util.Locale locale)
           
 void getImportRecordFieldData(Record record, java.lang.String strImportValue, boolean bTestDirectoryError, java.util.List<RecordField> listRecordField, java.util.Locale locale)
          save in the list of record field the record field associate to the entry
 java.lang.String getLabelValueAllSearch()
           
 IMapProvider getMapProvider()
          Gets the map provider
 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()
           
 void getRecordFieldData(Record record, javax.servlet.http.HttpServletRequest request, boolean bTestDirectoryError, boolean bAddNewValue, java.util.List<RecordField> listRecordField, java.util.Locale locale)
          save in the list of record field the record field associate to the entry
 void getRecordFieldData(Record record, java.util.List<java.lang.String> listValue, boolean bTestDirectoryError, boolean bAddNewValue, java.util.List<RecordField> listRecordField, java.util.Locale locale)
          save in the list of record field the record field associate to the entry
 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
 java.lang.String getRequestSQL()
           
 java.lang.String getTemplateCreate()
          Get template create url
 java.lang.String getTemplateModify()
          Get the template modify url
 java.lang.String getTitle()
           
 void getXml(fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale, java.lang.StringBuffer strXml)
          add The Xml of the entry in the string buffer
 boolean isAddValueAllSearch()
           
 boolean isAutocompleteEntry()
           
 boolean isFieldInLine()
           
 boolean isFirstInTheList()
           
 boolean isIndexed()
           
 boolean isLastInTheList()
           
 boolean isMandatory()
           
 boolean isMultipleSearchFields()
           
 boolean isRoleAssociated()
           
 boolean isShownInAdvancedSearch()
           
 boolean isShownInHistory()
           
 boolean isShownInResultList()
           
 boolean isShownInResultRecord()
           
 boolean isWorkgroupAssociated()
           
 void setAddValueAllSearch(boolean bAddValueAllSearch)
          set request SQL
 void setAutocompleteEntry(boolean bIsAutocompleEntry)
          set autocomplete entry type
 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 setDirectory(Directory directory)
          set the directory associate to the entry
 void setDisplayHeight(int height)
          set the height of the entry
 void setDisplayWidth(int width)
          set the width of the entry
 void setEntryAssociate(int idEntryAssociate)
          set id entry is display with Multiple search field
 void setEntryType(EntryType entryType)
          set the type of the entry
 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 setHelpMessage(java.lang.String helpMessage)
          set entry help message
 void setHelpMessageSearch(java.lang.String helpMessage)
          set the entry help message for search
 void setIdEntry(int idEntry)
          set the id of the entry
 void setIndexed(boolean indexed)
          set true if the field must be indexed
 void setLabelValueAllSearch(java.lang.String strLabelValueAllSearch)
          Get the request data
 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 setMapProvider(IMapProvider mapProvider)
          Sets the map provider
 void setMultipleSearchFields(boolean multipleSearchFields)
          set true if the entry is display with Multiple search field
 void setParent(IEntry parent)
          set parent entry if the entry is insert in a group
 void setPosition(int position)
          set position entry
 void setRequestSQL(java.lang.String strRequestSQL)
          set request SQL
 void setRoleAssociated(boolean bRoleAssociated)
          set true if a role can be associated with a item
 void setShownInAdvancedSearch(boolean shown)
          set true if the field must be shown advanced search
 void setShownInHistory(boolean shown)
          set true if the field must be shown in history page
 void setShownInResultList(boolean shown)
          set true if the field must be shown in result list page
 void setShownInResultRecord(boolean shown)
          set true if the field must be shown in result record page
 void setTitle(java.lang.String title)
          set title entry
 void setWorkgroupAssociated(boolean bWorkGroupAssociated)
          set true if a workgroup can be associated with a item
 

Method Detail

getIdEntry

int getIdEntry()
Returns:
the id of entry

setIdEntry

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

Parameters:
idEntry - the id of the entry

getDirectory

Directory getDirectory()
Returns:
the directory associate to the entry

setDirectory

void setDirectory(Directory directory)
set the directory associate to the entry

Parameters:
directory - the directory associate to the entry

getTitle

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

setTitle

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

Parameters:
title - title

getHelpMessage

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

setHelpMessage

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

Parameters:
helpMessage - entry helpMessage

getHelpMessageSearch

java.lang.String getHelpMessageSearch()
Returns:
the entry help message for search

setHelpMessageSearch

void setHelpMessageSearch(java.lang.String helpMessage)
set the entry help message for search

Parameters:
helpMessage - the entry help message for search

getComment

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

setComment

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

Parameters:
comment - entry comment

isMandatory

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

setMandatory

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

Parameters:
mandatory - true if the question is mandatory

isFieldInLine

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

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

isShownInAdvancedSearch

boolean isShownInAdvancedSearch()
Returns:
true if the field must be shown in advanced search

isShownInResultList

boolean isShownInResultList()
Returns:
true if the field must be shown in result list

setShownInResultList

void setShownInResultList(boolean shown)
set true if the field must be shown in result list page

Parameters:
shown - true if the entry must be shown in result list page

isShownInResultRecord

boolean isShownInResultRecord()
Returns:
true if the field must be shown in result record page

setShownInResultRecord

void setShownInResultRecord(boolean shown)
set true if the field must be shown in result record page

Parameters:
shown - true if the entry must be shown in result record page

isShownInHistory

boolean isShownInHistory()
Returns:
true if the field must be shown in result record page

setShownInHistory

void setShownInHistory(boolean shown)
set true if the field must be shown in history page

Parameters:
shown - true if the entry must be shown in history page

setShownInAdvancedSearch

void setShownInAdvancedSearch(boolean shown)
set true if the field must be shown advanced search

Parameters:
shown - true if the entry must be shown in advanced search

isIndexed

boolean isIndexed()
Returns:
true if the field must be indexed

setIndexed

void setIndexed(boolean indexed)
set true if the field must be indexed

Parameters:
indexed - true if the field must be indexed

getPosition

int getPosition()
Returns:
position entry

setPosition

void setPosition(int position)
set position entry

Parameters:
position - position entry

getEntryType

EntryType getEntryType()
Returns:
the type of the entry

setEntryType

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

Parameters:
entryType - the type of the entry

getFields

java.util.List<Field> getFields()
Returns:
the list of field who are associate to the 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

getParent

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

setParent

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

Parameters:
parent - parent entry

getChildren

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

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

isLastInTheList

boolean isLastInTheList()
Returns:
true if the entry is the last entry of a group or the list of 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

isFirstInTheList

boolean isFirstInTheList()
Returns:
true if the entry is the first 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

getDisplayWidth

int getDisplayWidth()
Returns:
the width of the entry

setDisplayWidth

void setDisplayWidth(int width)
set the width of the entry

Parameters:
width - width of the entry

getDisplayHeight

int getDisplayHeight()
Returns:
the height of the entry

setDisplayHeight

void setDisplayHeight(int height)
set the height of the entry

Parameters:
height - the height of the entry

isRoleAssociated

boolean isRoleAssociated()
Returns:
true if a role can be associated with a item

setRoleAssociated

void setRoleAssociated(boolean bRoleAssociated)
set true if a role can be associated with a item

Parameters:
bRoleAssociated - true if a role can be associated with a item

isWorkgroupAssociated

boolean isWorkgroupAssociated()
Returns:
true if a workgroup can be associated with a item

setWorkgroupAssociated

void setWorkgroupAssociated(boolean bWorkGroupAssociated)
set true if a workgroup can be associated with a item

Parameters:
bWorkGroupAssociated - true if a workgroup can be associated with a item

isMultipleSearchFields

boolean isMultipleSearchFields()
Returns:
true if the entry is display with Multiple search field

setMultipleSearchFields

void setMultipleSearchFields(boolean multipleSearchFields)
set true if the entry is display with Multiple search field

Parameters:
multipleSearchFields - true if the entry is display with Multiple search field

getEntryAssociate

int getEntryAssociate()
Returns:
the id entry associed

setEntryAssociate

void setEntryAssociate(int idEntryAssociate)
set id entry is display with Multiple search field

Parameters:
idEntryAssociate - id entry

getRequestSQL

java.lang.String getRequestSQL()
Returns:
the request SQL

setRequestSQL

void setRequestSQL(java.lang.String strRequestSQL)
set request SQL

Parameters:
strRequestSQL - request SQL

isAddValueAllSearch

boolean isAddValueAllSearch()
Returns:
true if add value for all search

setAddValueAllSearch

void setAddValueAllSearch(boolean bAddValueAllSearch)
set request SQL

Parameters:
strRequestSQL - request SQL

isAutocompleteEntry

boolean isAutocompleteEntry()
Returns:
true if entry is autocomplete

setAutocompleteEntry

void setAutocompleteEntry(boolean bIsAutocompleEntry)
set autocomplete entry type

Parameters:
bIsAutocompleEntry -

getLabelValueAllSearch

java.lang.String getLabelValueAllSearch()
Returns:
the label of value for all search

setLabelValueAllSearch

void setLabelValueAllSearch(java.lang.String strLabelValueAllSearch)
Get the request data

Parameters:
request - HttpRequest
locale - the locale

getEntryData

java.lang.String getEntryData(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

getRecordFieldData

void getRecordFieldData(Record record,
                        javax.servlet.http.HttpServletRequest request,
                        boolean bTestDirectoryError,
                        boolean bAddNewValue,
                        java.util.List<RecordField> listRecordField,
                        java.util.Locale locale)
                        throws DirectoryErrorException
save in the list of record field the record field associate to the entry

Parameters:
record - the record associated to the record field
request - HttpRequest
bTestDirectoryError - true if the value contains in the request must be tested
listRecordField - the list of record field associate to the record
locale - the locale
Throws:
DirectoryErrorException

getRecordFieldData

void getRecordFieldData(Record record,
                        java.util.List<java.lang.String> listValue,
                        boolean bTestDirectoryError,
                        boolean bAddNewValue,
                        java.util.List<RecordField> listRecordField,
                        java.util.Locale locale)
                        throws DirectoryErrorException
save in the list of record field the record field associate to the entry

Parameters:
listValue - the list which contains the string value of the record field
bTestDirectoryError - true if the value contains in the request must be tested
listRecordField - the list of record field associate to the record
locale - the locale
Throws:
DirectoryErrorException

getImportRecordFieldData

void getImportRecordFieldData(Record record,
                              java.lang.String strImportValue,
                              boolean bTestDirectoryError,
                              java.util.List<RecordField> listRecordField,
                              java.util.Locale locale)
                              throws DirectoryErrorException
save in the list of record field the record field associate to the entry

Parameters:
record - the record associated to the record field
strImportValue - the import string which contains the string value of the record field
bTestDirectoryError - true if the value contains in the request must be tested
listRecordField - the list of record field associate to the record
locale - the locale
Throws:
DirectoryErrorException

getTemplateCreate

java.lang.String getTemplateCreate()
Get template create url

Returns:
template create url

getTemplateModify

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

Returns:
template modify url

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

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

getHtmlFormEntry

java.lang.String getHtmlFormEntry(java.util.Locale locale,
                                  boolean isDisplayFront)
Get Html code used in entry form

Parameters:
locale - the locale
isDisplayFront - true if the template front or false if the template back
Returns:
html code

getHtmlFormEntry

java.lang.String getHtmlFormEntry(java.util.Locale locale,
                                  java.util.List<RecordField> listRecordField,
                                  boolean isDisplayFront)
Get Html code used in entry form

Parameters:
locale - the locale
listRecordField - the list of record field associate to the entry
isDisplayFront - true if the template front or false if the template back
Returns:
html code

getHtmlFormSearchEntry

java.lang.String getHtmlFormSearchEntry(java.util.Locale locale,
                                        boolean isDisplayFront)
Get Html code used in search form

Parameters:
locale - the locale
isDisplayFront - true if the template front or false if the template back
Returns:
html code

getHtmlFormSearchEntry

java.lang.String getHtmlFormSearchEntry(java.util.Locale locale,
                                        java.util.List<RecordField> listRecordField,
                                        boolean isDisplayFront)
Get Html code used in search form

Parameters:
locale - the locale
listRecordField - the list of record field associate to the entry
isDisplayFront - true if the template front or false if the template back
Returns:
html code

getHtmlRecordFieldValue

java.lang.String getHtmlRecordFieldValue(java.util.Locale locale,
                                         RecordField recordField,
                                         boolean isDisplayFront)
Get the Html code used in display records

Parameters:
locale - the locale
recordField - the record field associate to the entry
isDisplayFront - true if the template front or false if the template back
Returns:
html code

convertRecordFieldValueToString

java.lang.String convertRecordFieldValueToString(RecordField recordField,
                                                 java.util.Locale locale,
                                                 boolean bDisplayFront,
                                                 boolean bDisplayExport)
convert the value contains in the record field to string

Parameters:
recordField - the recordField
locale - the locale
bDisplayFront - true if display front or false if display back
bDisplayExport - true if display export
Returns:
string

convertRecordFieldTitleToString

java.lang.String convertRecordFieldTitleToString(RecordField recordField,
                                                 java.util.Locale locale,
                                                 boolean bDisplayFront)
convert the title contains in the record field to string

Parameters:
recordField - the recordField
locale - the locale
bDisplayFront - true if display front or false if display back
Returns:
string

addSearchCriteria

void addSearchCriteria(java.util.HashMap<java.lang.String,java.lang.Object> mapSearchItem,
                       RecordField recordField)
add in the search map the criteria

Parameters:
recordField - the record field
mapSearchItem - Search map

getXml

void getXml(fr.paris.lutece.portal.service.plugin.Plugin plugin,
            java.util.Locale locale,
            java.lang.StringBuffer strXml)
add The Xml of the entry in the string buffer

Parameters:
plugin - plugin
locale - loclae
strXml - the string buffer

getImportRecordFieldData

void getImportRecordFieldData(Record record,
                              byte[] decodedBytes,
                              java.lang.String nomFile,
                              boolean b,
                              java.util.List<RecordField> listRecordField,
                              java.util.Locale locale)
                              throws DirectoryErrorException
Throws:
DirectoryErrorException

setMapProvider

void setMapProvider(IMapProvider mapProvider)
Sets the map provider

Parameters:
mapProvider - the map provider

getMapProvider

IMapProvider getMapProvider()
Gets the map provider

Returns:
the map provider


Copyright © 2010 Mairie de Paris. All Rights Reserved.