fr.paris.lutece.plugins.directory.business
Class Entry

java.lang.Object
  extended by fr.paris.lutece.plugins.directory.business.Entry
All Implemented Interfaces:
IEntry
Direct Known Subclasses:
EntryTypeCheckBox, EntryTypeComment, EntryTypeDate, EntryTypeDirectory, EntryTypeDownloadUrl, EntryTypeFile, EntryTypeGeolocation, EntryTypeGroup, EntryTypeImg, EntryTypeInternalLink, EntryTypeMail, EntryTypeMyLuteceUser, EntryTypeNumbering, EntryTypeRadioButton, EntryTypeRemoteMyLuteceUser, EntryTypeRichText, EntryTypeSelect, EntryTypeSQL, EntryTypeText, EntryTypeTextArea, EntryTypeUrl

public class Entry
extends java.lang.Object
implements IEntry

class Entry


Field Summary
static java.lang.String ATTRIBUTE_ENTRY_ID
           
static java.lang.String ATTRIBUTE_ENTRY_ID_TYPE
           
static java.lang.String ATTRIBUTE_SHOWXY
           
static java.lang.String ATTRIBUTE_TITLE
           
protected static java.lang.String FIELD_COMMENT
           
protected static java.lang.String FIELD_ENTRY_ASSOCIATE
           
protected static java.lang.String FIELD_HEIGHT
           
protected static java.lang.String FIELD_HEIGHT_DISPLAY
           
protected static java.lang.String FIELD_HELP_MESSAGE
           
protected static java.lang.String FIELD_HELP_MESSAGE_SEARCH
           
protected static java.lang.String FIELD_INSERT_GROUP
           
protected static java.lang.String FIELD_LABEL_ALL_SEARCH
           
protected static java.lang.String FIELD_MANDATORY
           
protected static java.lang.String FIELD_MAX_SIZE_ENTER
           
protected static java.lang.String FIELD_PRESENTATION
           
protected static java.lang.String FIELD_REQUEST_SQL
           
protected static java.lang.String FIELD_TITLE
           
protected static java.lang.String FIELD_VALUE
           
protected static java.lang.String FIELD_WIDTH
           
protected static java.lang.String FIELD_WIDTH_DISPLAY
           
protected static java.lang.String JSP_DOWNLOAD_FILE
           
protected static java.lang.String MARK_DEFAULT_VALUES
           
protected static java.lang.String MARK_ENTRY
           
protected static java.lang.String MARK_LOCALE
           
protected static java.lang.String MARK_MYLUTECE_USER_INFOS_LIST
           
protected static java.lang.String MARK_MYLUTECE_USER_LOGIN
           
protected static java.lang.String MARK_RECORD_FIELD
           
protected static java.lang.String MARK_SHOW_ALL_INFO
           
protected static java.lang.String MESSAGE_MANDATORY_FIELD
           
protected static java.lang.String MESSAGE_NUMERIC_FIELD
           
protected static java.lang.String PARAMETER_AUTOCOMPLETE
           
protected static java.lang.String PARAMETER_COMMENT
           
protected static java.lang.String PARAMETER_DATE_BEGIN
           
protected static java.lang.String PARAMETER_DATE_END
           
protected static java.lang.String PARAMETER_DIRECTORY_ASSOCIATE
           
protected static java.lang.String PARAMETER_DISPLAY_HEIGHT
           
protected static java.lang.String PARAMETER_DISPLAY_WIDTH
           
protected static java.lang.String PARAMETER_ENTRY_ASSOCIATE
           
protected static java.lang.String PARAMETER_FIELD_IN_LINE
           
protected static java.lang.String PARAMETER_HEIGHT
           
protected static java.lang.String PARAMETER_HELP_MESSAGE
           
protected static java.lang.String PARAMETER_HELP_MESSAGE_SEARCH
           
protected static java.lang.String PARAMETER_ID_DIRECTORY_RECORD
           
protected static java.lang.String PARAMETER_INDEXED
           
protected static java.lang.String PARAMETER_INDEXED_AS_SUMMARY
           
protected static java.lang.String PARAMETER_INDEXED_AS_TITLE
           
protected static java.lang.String PARAMETER_IS_ADD_VALUE_SEARCH_ALL
           
protected static java.lang.String PARAMETER_LABEL_VALUE_SEARCH_ALL
           
protected static java.lang.String PARAMETER_MANDATORY
           
protected static java.lang.String PARAMETER_MAX_SIZE_ENTER
           
protected static java.lang.String PARAMETER_MULTIPLE_SEARCH_FIELDS
           
protected static java.lang.String PARAMETER_REQUEST_SQL
           
protected static java.lang.String PARAMETER_ROLE_ASSOCIATED
           
protected static java.lang.String PARAMETER_SEARCH_ACTION
           
protected static java.lang.String PARAMETER_SHOW_ALL_INFO
           
protected static java.lang.String PARAMETER_SHOWN_IN_ADVANCED_SEARCH
           
protected static java.lang.String PARAMETER_SHOWN_IN_COMPLETENESS
           
protected static java.lang.String PARAMETER_SHOWN_IN_EXPORT
           
protected static java.lang.String PARAMETER_SHOWN_IN_HISTORY
           
protected static java.lang.String PARAMETER_SHOWN_IN_RESULT_LIST
           
protected static java.lang.String PARAMETER_SHOWN_IN_RESULT_RECORD
           
protected static java.lang.String PARAMETER_TITLE
           
protected static java.lang.String PARAMETER_UPDATE_ENTRY
           
protected static java.lang.String PARAMETER_VALUE
           
protected static java.lang.String PARAMETER_WIDTH
           
protected static java.lang.String PARAMETER_WORKGROUP_ASSOCIATED
           
protected static java.lang.String PROPERTY_IMPORT_MULTIPLE_VALUE_DELIMITER
           
static java.lang.String TAG_ENTRY
           
static java.lang.String TAG_LIST_ENTRY
           
static java.lang.String TAG_TITLE
           
 
Constructor Summary
Entry()
           
 
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 bExportDirectory)
          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> defaultValues, 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> defaultValues, 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
 fr.paris.lutece.portal.web.util.LocalizedPaginator getPaginator(int nItemPerPage, java.lang.String strBaseUrl, java.lang.String strPageIndexParameterName, java.lang.String strPageIndex, java.util.Locale locale)
          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> lstValue, 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 getSQLJoin()
          Provide default join on directory_record_field
 java.lang.String getSQLOrderBy()
          Provides default order by on directory_record_field.record_field_value
 java.util.List<java.lang.Object> getSQLParametersValues()
          Returns the entry id
 java.lang.String getTemplateCreate()
          Get template create url
 java.lang.String getTemplateHtmlFormEntry(boolean isDisplayFront)
          Get the url of the template wich contains the Html code used in entry form
 java.lang.String getTemplateHtmlFormSearchEntry(boolean isDisplayFront)
          Get the url of the template wich contains the Html code used in search form
 java.lang.String getTemplateHtmlRecordFieldValue(boolean isDisplayFront)
          Get the url of the template wich contains the Html code used in display records
 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 isIndexedAsSummary()
          
 boolean isIndexedAsTitle()
          
 boolean isLastInTheList()
           
 boolean isMandatory()
           
 boolean isMultipleSearchFields()
           
 boolean isRoleAssociated()
           
 boolean isShownInAdvancedSearch()
           
 boolean isShownInCompleteness()
           
 boolean isShownInExport()
           
 boolean isShownInHistory()
           
 boolean isShownInResultList()
           
 boolean isShownInResultRecord()
           
 boolean isSortable()
          Check if the entry is sortable
 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 setIndexedAsSummary(boolean indexedAsSummary)
          set true if the field is (part of) the summary of the document in the global index
 void setIndexedAsTitle(boolean indexedAsTitle)
          set true if the field is (part of) the title of the document in the global index
 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 setShownInCompleteness(boolean shown)
          set true if the field must be shown record completeness
 void setShownInExport(boolean shown)
          set true if the field must be shown in data export
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TAG_ENTRY

public static final java.lang.String TAG_ENTRY
See Also:
Constant Field Values

ATTRIBUTE_ENTRY_ID

public static final java.lang.String ATTRIBUTE_ENTRY_ID
See Also:
Constant Field Values

TAG_TITLE

public static final java.lang.String TAG_TITLE
See Also:
Constant Field Values

ATTRIBUTE_TITLE

public static final java.lang.String ATTRIBUTE_TITLE
See Also:
Constant Field Values

ATTRIBUTE_ENTRY_ID_TYPE

public static final java.lang.String ATTRIBUTE_ENTRY_ID_TYPE
See Also:
Constant Field Values

TAG_LIST_ENTRY

public static final java.lang.String TAG_LIST_ENTRY
See Also:
Constant Field Values

ATTRIBUTE_SHOWXY

public static final java.lang.String ATTRIBUTE_SHOWXY
See Also:
Constant Field Values

PARAMETER_TITLE

protected static final java.lang.String PARAMETER_TITLE
See Also:
Constant Field Values

PARAMETER_HELP_MESSAGE

protected static final java.lang.String PARAMETER_HELP_MESSAGE
See Also:
Constant Field Values

PARAMETER_HELP_MESSAGE_SEARCH

protected static final java.lang.String PARAMETER_HELP_MESSAGE_SEARCH
See Also:
Constant Field Values

PARAMETER_COMMENT

protected static final java.lang.String PARAMETER_COMMENT
See Also:
Constant Field Values

PARAMETER_MANDATORY

protected static final java.lang.String PARAMETER_MANDATORY
See Also:
Constant Field Values

PARAMETER_INDEXED

protected static final java.lang.String PARAMETER_INDEXED
See Also:
Constant Field Values

PARAMETER_INDEXED_AS_TITLE

protected static final java.lang.String PARAMETER_INDEXED_AS_TITLE
See Also:
Constant Field Values

PARAMETER_INDEXED_AS_SUMMARY

protected static final java.lang.String PARAMETER_INDEXED_AS_SUMMARY
See Also:
Constant Field Values

PARAMETER_MULTIPLE_SEARCH_FIELDS

protected static final java.lang.String PARAMETER_MULTIPLE_SEARCH_FIELDS
See Also:
Constant Field Values

PARAMETER_SHOWN_IN_ADVANCED_SEARCH

protected static final java.lang.String PARAMETER_SHOWN_IN_ADVANCED_SEARCH
See Also:
Constant Field Values

PARAMETER_SHOWN_IN_RESULT_LIST

protected static final java.lang.String PARAMETER_SHOWN_IN_RESULT_LIST
See Also:
Constant Field Values

PARAMETER_SHOWN_IN_RESULT_RECORD

protected static final java.lang.String PARAMETER_SHOWN_IN_RESULT_RECORD
See Also:
Constant Field Values

PARAMETER_SHOWN_IN_HISTORY

protected static final java.lang.String PARAMETER_SHOWN_IN_HISTORY
See Also:
Constant Field Values

PARAMETER_AUTOCOMPLETE

protected static final java.lang.String PARAMETER_AUTOCOMPLETE
See Also:
Constant Field Values

PARAMETER_FIELD_IN_LINE

protected static final java.lang.String PARAMETER_FIELD_IN_LINE
See Also:
Constant Field Values

PARAMETER_HEIGHT

protected static final java.lang.String PARAMETER_HEIGHT
See Also:
Constant Field Values

PARAMETER_WIDTH

protected static final java.lang.String PARAMETER_WIDTH
See Also:
Constant Field Values

PARAMETER_DISPLAY_HEIGHT

protected static final java.lang.String PARAMETER_DISPLAY_HEIGHT
See Also:
Constant Field Values

PARAMETER_DISPLAY_WIDTH

protected static final java.lang.String PARAMETER_DISPLAY_WIDTH
See Also:
Constant Field Values

PARAMETER_VALUE

protected static final java.lang.String PARAMETER_VALUE
See Also:
Constant Field Values

PARAMETER_MAX_SIZE_ENTER

protected static final java.lang.String PARAMETER_MAX_SIZE_ENTER
See Also:
Constant Field Values

PARAMETER_ID_DIRECTORY_RECORD

protected static final java.lang.String PARAMETER_ID_DIRECTORY_RECORD
See Also:
Constant Field Values

PARAMETER_UPDATE_ENTRY

protected static final java.lang.String PARAMETER_UPDATE_ENTRY
See Also:
Constant Field Values

PARAMETER_WORKGROUP_ASSOCIATED

protected static final java.lang.String PARAMETER_WORKGROUP_ASSOCIATED
See Also:
Constant Field Values

PARAMETER_ROLE_ASSOCIATED

protected static final java.lang.String PARAMETER_ROLE_ASSOCIATED
See Also:
Constant Field Values

PARAMETER_SEARCH_ACTION

protected static final java.lang.String PARAMETER_SEARCH_ACTION
See Also:
Constant Field Values

PARAMETER_DATE_BEGIN

protected static final java.lang.String PARAMETER_DATE_BEGIN
See Also:
Constant Field Values

PARAMETER_DATE_END

protected static final java.lang.String PARAMETER_DATE_END
See Also:
Constant Field Values

PARAMETER_DIRECTORY_ASSOCIATE

protected static final java.lang.String PARAMETER_DIRECTORY_ASSOCIATE
See Also:
Constant Field Values

PARAMETER_ENTRY_ASSOCIATE

protected static final java.lang.String PARAMETER_ENTRY_ASSOCIATE
See Also:
Constant Field Values

PARAMETER_REQUEST_SQL

protected static final java.lang.String PARAMETER_REQUEST_SQL
See Also:
Constant Field Values

PARAMETER_IS_ADD_VALUE_SEARCH_ALL

protected static final java.lang.String PARAMETER_IS_ADD_VALUE_SEARCH_ALL
See Also:
Constant Field Values

PARAMETER_LABEL_VALUE_SEARCH_ALL

protected static final java.lang.String PARAMETER_LABEL_VALUE_SEARCH_ALL
See Also:
Constant Field Values

PARAMETER_SHOWN_IN_EXPORT

protected static final java.lang.String PARAMETER_SHOWN_IN_EXPORT
See Also:
Constant Field Values

PARAMETER_SHOWN_IN_COMPLETENESS

protected static final java.lang.String PARAMETER_SHOWN_IN_COMPLETENESS
See Also:
Constant Field Values

PARAMETER_SHOW_ALL_INFO

protected static final java.lang.String PARAMETER_SHOW_ALL_INFO
See Also:
Constant Field Values

MESSAGE_MANDATORY_FIELD

protected static final java.lang.String MESSAGE_MANDATORY_FIELD
See Also:
Constant Field Values

MESSAGE_NUMERIC_FIELD

protected static final java.lang.String MESSAGE_NUMERIC_FIELD
See Also:
Constant Field Values

FIELD_TITLE

protected static final java.lang.String FIELD_TITLE
See Also:
Constant Field Values

FIELD_INSERT_GROUP

protected static final java.lang.String FIELD_INSERT_GROUP
See Also:
Constant Field Values

FIELD_HELP_MESSAGE

protected static final java.lang.String FIELD_HELP_MESSAGE
See Also:
Constant Field Values

FIELD_HELP_MESSAGE_SEARCH

protected static final java.lang.String FIELD_HELP_MESSAGE_SEARCH
See Also:
Constant Field Values

FIELD_COMMENT

protected static final java.lang.String FIELD_COMMENT
See Also:
Constant Field Values

FIELD_VALUE

protected static final java.lang.String FIELD_VALUE
See Also:
Constant Field Values

FIELD_PRESENTATION

protected static final java.lang.String FIELD_PRESENTATION
See Also:
Constant Field Values

FIELD_MANDATORY

protected static final java.lang.String FIELD_MANDATORY
See Also:
Constant Field Values

FIELD_WIDTH

protected static final java.lang.String FIELD_WIDTH
See Also:
Constant Field Values

FIELD_HEIGHT

protected static final java.lang.String FIELD_HEIGHT
See Also:
Constant Field Values

FIELD_WIDTH_DISPLAY

protected static final java.lang.String FIELD_WIDTH_DISPLAY
See Also:
Constant Field Values

FIELD_HEIGHT_DISPLAY

protected static final java.lang.String FIELD_HEIGHT_DISPLAY
See Also:
Constant Field Values

FIELD_MAX_SIZE_ENTER

protected static final java.lang.String FIELD_MAX_SIZE_ENTER
See Also:
Constant Field Values

FIELD_ENTRY_ASSOCIATE

protected static final java.lang.String FIELD_ENTRY_ASSOCIATE
See Also:
Constant Field Values

FIELD_REQUEST_SQL

protected static final java.lang.String FIELD_REQUEST_SQL
See Also:
Constant Field Values

FIELD_LABEL_ALL_SEARCH

protected static final java.lang.String FIELD_LABEL_ALL_SEARCH
See Also:
Constant Field Values

JSP_DOWNLOAD_FILE

protected static final java.lang.String JSP_DOWNLOAD_FILE
See Also:
Constant Field Values

MARK_ENTRY

protected static final java.lang.String MARK_ENTRY
See Also:
Constant Field Values

MARK_LOCALE

protected static final java.lang.String MARK_LOCALE
See Also:
Constant Field Values

MARK_RECORD_FIELD

protected static final java.lang.String MARK_RECORD_FIELD
See Also:
Constant Field Values

MARK_DEFAULT_VALUES

protected static final java.lang.String MARK_DEFAULT_VALUES
See Also:
Constant Field Values

MARK_SHOW_ALL_INFO

protected static final java.lang.String MARK_SHOW_ALL_INFO
See Also:
Constant Field Values

MARK_MYLUTECE_USER_INFOS_LIST

protected static final java.lang.String MARK_MYLUTECE_USER_INFOS_LIST
See Also:
Constant Field Values

MARK_MYLUTECE_USER_LOGIN

protected static final java.lang.String MARK_MYLUTECE_USER_LOGIN
See Also:
Constant Field Values

PROPERTY_IMPORT_MULTIPLE_VALUE_DELIMITER

protected static final java.lang.String PROPERTY_IMPORT_MULTIPLE_VALUE_DELIMITER
See Also:
Constant Field Values
Constructor Detail

Entry

public Entry()
Method Detail

getIdEntry

public int getIdEntry()
Specified by:
getIdEntry in interface IEntry
Returns:
the id of entry

setIdEntry

public void setIdEntry(int idEntry)
Description copied from interface: IEntry
set the id of the entry

Specified by:
setIdEntry in interface IEntry
Parameters:
idEntry - the id of the entry

getDirectory

public Directory getDirectory()
Specified by:
getDirectory in interface IEntry
Returns:
the directory associate to the entry

setDirectory

public void setDirectory(Directory directory)
Description copied from interface: IEntry
set the directory associate to the entry

Specified by:
setDirectory in interface IEntry
Parameters:
directory - the directory associate to the entry

getTitle

public java.lang.String getTitle()
Specified by:
getTitle in interface IEntry
Returns:
title entry

setTitle

public void setTitle(java.lang.String title)
Description copied from interface: IEntry
set title entry

Specified by:
setTitle in interface IEntry
Parameters:
title - title

getHelpMessage

public java.lang.String getHelpMessage()
Specified by:
getHelpMessage in interface IEntry
Returns:
the entry help message

setHelpMessage

public void setHelpMessage(java.lang.String helpMessage)
Description copied from interface: IEntry
set entry help message

Specified by:
setHelpMessage in interface IEntry
Parameters:
helpMessage - entry helpMessage

getHelpMessageSearch

public java.lang.String getHelpMessageSearch()
Specified by:
getHelpMessageSearch in interface IEntry
Returns:
the entry help message for search

setHelpMessageSearch

public void setHelpMessageSearch(java.lang.String helpMessage)
Description copied from interface: IEntry
set the entry help message for search

Specified by:
setHelpMessageSearch in interface IEntry
Parameters:
helpMessage - the entry help message for search

getComment

public java.lang.String getComment()
Specified by:
getComment in interface IEntry
Returns:
the entry comment

setComment

public void setComment(java.lang.String comment)
Description copied from interface: IEntry
set entry comment

Specified by:
setComment in interface IEntry
Parameters:
comment - entry comment

isMandatory

public boolean isMandatory()
Specified by:
isMandatory in interface IEntry
Returns:
true if the question is mandatory

setMandatory

public void setMandatory(boolean mandatory)
Description copied from interface: IEntry
set true if the question is mandatory

Specified by:
setMandatory in interface IEntry
Parameters:
mandatory - true if the question is mandatory

isFieldInLine

public boolean isFieldInLine()
Specified by:
isFieldInLine in interface IEntry
Returns:
true if the field associate must be display in line

setFieldInLine

public void setFieldInLine(boolean fieldInLine)
Description copied from interface: IEntry
set true if the field associate must be display in line

Specified by:
setFieldInLine in interface IEntry
Parameters:
fieldInLine - true if the field associate must be display in line

isShownInAdvancedSearch

public boolean isShownInAdvancedSearch()
Specified by:
isShownInAdvancedSearch in interface IEntry
Returns:
true if the field must be shown in advanced search

setShownInAdvancedSearch

public void setShownInAdvancedSearch(boolean shown)
Description copied from interface: IEntry
set true if the field must be shown advanced search

Specified by:
setShownInAdvancedSearch in interface IEntry
Parameters:
shown - true if the entry must be shown in advanced search

isShownInResultList

public boolean isShownInResultList()
Specified by:
isShownInResultList in interface IEntry
Returns:
true if the field must be shown in result list

setShownInResultList

public void setShownInResultList(boolean shown)
Description copied from interface: IEntry
set true if the field must be shown in result list page

Specified by:
setShownInResultList in interface IEntry
Parameters:
shown - true if the entry must be shown in result list page

isShownInResultRecord

public boolean isShownInResultRecord()
Specified by:
isShownInResultRecord in interface IEntry
Returns:
true if the field must be shown in result record page

setShownInResultRecord

public void setShownInResultRecord(boolean shown)
Description copied from interface: IEntry
set true if the field must be shown in result record page

Specified by:
setShownInResultRecord in interface IEntry
Parameters:
shown - true if the entry must be shown in result record page

isShownInHistory

public boolean isShownInHistory()
Specified by:
isShownInHistory in interface IEntry
Returns:
true if the field must be shown in result record page

setShownInHistory

public void setShownInHistory(boolean shown)
Description copied from interface: IEntry
set true if the field must be shown in history page

Specified by:
setShownInHistory in interface IEntry
Parameters:
shown - true if the entry must be shown in history page

isShownInExport

public boolean isShownInExport()
Specified by:
isShownInExport in interface IEntry
Returns:
true if the field must be shown in data export

setShownInExport

public void setShownInExport(boolean shown)
Description copied from interface: IEntry
set true if the field must be shown in data export

Specified by:
setShownInExport in interface IEntry
Parameters:
shown - true if the entry must be shown in data export

isShownInCompleteness

public boolean isShownInCompleteness()
Specified by:
isShownInCompleteness in interface IEntry
Returns:
true if the field must be shown in record completeness

setShownInCompleteness

public void setShownInCompleteness(boolean shown)
Description copied from interface: IEntry
set true if the field must be shown record completeness

Specified by:
setShownInCompleteness in interface IEntry
Parameters:
shown - true if the entry must be shown in record completeness

isIndexed

public boolean isIndexed()
Specified by:
isIndexed in interface IEntry
Returns:
true if the field must be indexed

setIndexed

public void setIndexed(boolean indexed)
Description copied from interface: IEntry
set true if the field must be indexed

Specified by:
setIndexed in interface IEntry
Parameters:
indexed - true if the field must be indexed

getPosition

public int getPosition()
Specified by:
getPosition in interface IEntry
Returns:
position entry

setPosition

public void setPosition(int position)
Description copied from interface: IEntry
set position entry

Specified by:
setPosition in interface IEntry
Parameters:
position - position entry

getEntryType

public EntryType getEntryType()
Specified by:
getEntryType in interface IEntry
Returns:
the type of the entry

setEntryType

public void setEntryType(EntryType entryType)
Description copied from interface: IEntry
set the type of the entry

Specified by:
setEntryType in interface IEntry
Parameters:
entryType - the type of the entry

getFields

public java.util.List<Field> getFields()
Specified by:
getFields in interface IEntry
Returns:
the list of field who are associate to the entry

setFields

public void setFields(java.util.List<Field> fields)
Description copied from interface: IEntry
set the list of field who are associate to the entry

Specified by:
setFields in interface IEntry
Parameters:
fields - the list of field

getParent

public IEntry getParent()
Specified by:
getParent in interface IEntry
Returns:
parent entry if the entry is insert in a group

setParent

public void setParent(IEntry parent)
Description copied from interface: IEntry
set parent entry if the entry is insert in a group

Specified by:
setParent in interface IEntry
Parameters:
parent - parent entry

getChildren

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

setChildren

public void setChildren(java.util.List<IEntry> children)
Description copied from interface: IEntry
set the list of entry who are insert in the group

Specified by:
setChildren in interface IEntry
Parameters:
children - the list of entry

isLastInTheList

public boolean isLastInTheList()
Specified by:
isLastInTheList in interface IEntry
Returns:
true if the entry is the last entry of a group or the list of entry

setLastInTheList

public void setLastInTheList(boolean lastInTheList)
Description copied from interface: IEntry
set true if the entry is the last entry of a group or the list of entry

Specified by:
setLastInTheList in interface IEntry
Parameters:
lastInTheList - true if the entry is the last entry of a group or the list of entry

isFirstInTheList

public boolean isFirstInTheList()
Specified by:
isFirstInTheList in interface IEntry
Returns:
true if the entry is the first entry of a group or the list of entry

setFirstInTheList

public void setFirstInTheList(boolean firstInTheList)
Description copied from interface: IEntry
set true if the entry is the first entry of a group or the list of entry

Specified by:
setFirstInTheList in interface IEntry
Parameters:
firstInTheList - true if the entry is the last entry of a group or the list of entry

getDisplayWidth

public int getDisplayWidth()
Specified by:
getDisplayWidth in interface IEntry
Returns:
the width of the entry

setDisplayWidth

public void setDisplayWidth(int width)
Description copied from interface: IEntry
set the width of the entry

Specified by:
setDisplayWidth in interface IEntry
Parameters:
width - width of the entry

getDisplayHeight

public int getDisplayHeight()
Specified by:
getDisplayHeight in interface IEntry
Returns:
the height of the entry

setDisplayHeight

public void setDisplayHeight(int height)
Description copied from interface: IEntry
set the height of the entry

Specified by:
setDisplayHeight in interface IEntry
Parameters:
height - the height of the entry

isRoleAssociated

public boolean isRoleAssociated()
Specified by:
isRoleAssociated in interface IEntry
Returns:
true if a role can be associated with a item

setRoleAssociated

public void setRoleAssociated(boolean bRoleAssociated)
Description copied from interface: IEntry
set true if a role can be associated with a item

Specified by:
setRoleAssociated in interface IEntry
Parameters:
bRoleAssociated - true if a role can be associated with a item

isWorkgroupAssociated

public boolean isWorkgroupAssociated()
Specified by:
isWorkgroupAssociated in interface IEntry
Returns:
true if a workgroup can be associated with a item

setWorkgroupAssociated

public void setWorkgroupAssociated(boolean bWorkGroupAssociated)
Description copied from interface: IEntry
set true if a workgroup can be associated with a item

Specified by:
setWorkgroupAssociated in interface IEntry
Parameters:
bWorkGroupAssociated - true if a workgroup can be associated with a item

isMultipleSearchFields

public boolean isMultipleSearchFields()
Specified by:
isMultipleSearchFields in interface IEntry
Returns:
true if the entry is display with Multiple search field

setMultipleSearchFields

public void setMultipleSearchFields(boolean multipleSearchFields)
Description copied from interface: IEntry
set true if the entry is display with Multiple search field

Specified by:
setMultipleSearchFields in interface IEntry
Parameters:
multipleSearchFields - true if the entry is display with Multiple search field

getEntryAssociate

public int getEntryAssociate()
Specified by:
getEntryAssociate in interface IEntry
Returns:
the id entry associed

setEntryAssociate

public void setEntryAssociate(int idEntryAssociate)
Description copied from interface: IEntry
set id entry is display with Multiple search field

Specified by:
setEntryAssociate in interface IEntry
Parameters:
idEntryAssociate - id entry

getRequestSQL

public java.lang.String getRequestSQL()
Specified by:
getRequestSQL in interface IEntry
Returns:
the request SQL

setRequestSQL

public void setRequestSQL(java.lang.String strRequestSQL)
Description copied from interface: IEntry
set request SQL

Specified by:
setRequestSQL in interface IEntry
Parameters:
strRequestSQL - request SQL

isAddValueAllSearch

public boolean isAddValueAllSearch()
Specified by:
isAddValueAllSearch in interface IEntry
Returns:
true if add value for all search

setAddValueAllSearch

public void setAddValueAllSearch(boolean bAddValueAllSearch)
Description copied from interface: IEntry
set request SQL

Specified by:
setAddValueAllSearch in interface IEntry

isAutocompleteEntry

public boolean isAutocompleteEntry()
Specified by:
isAutocompleteEntry in interface IEntry
Returns:
true if entry is autocomplete

setAutocompleteEntry

public void setAutocompleteEntry(boolean bIsAutocompleEntry)
Description copied from interface: IEntry
set autocomplete entry type

Specified by:
setAutocompleteEntry in interface IEntry

getLabelValueAllSearch

public java.lang.String getLabelValueAllSearch()
Specified by:
getLabelValueAllSearch in interface IEntry
Returns:
the label of value for all search

setLabelValueAllSearch

public void setLabelValueAllSearch(java.lang.String strLabelValueAllSearch)
Description copied from interface: IEntry
Get the request data

Specified by:
setLabelValueAllSearch in interface IEntry

getTemplateHtmlFormEntry

public java.lang.String getTemplateHtmlFormEntry(boolean isDisplayFront)
Get the url of the template wich contains the Html code used in entry form

Parameters:
true - if display for front office or false if display for back office
Returns:
the template url

getTemplateHtmlFormSearchEntry

public java.lang.String getTemplateHtmlFormSearchEntry(boolean isDisplayFront)
Get the url of the template wich contains the Html code used in search form

Parameters:
true - if display for front office or false if display for back office
Returns:
the template url

getTemplateHtmlRecordFieldValue

public java.lang.String getTemplateHtmlRecordFieldValue(boolean isDisplayFront)
Get the url of the template wich contains the Html code used in display records

Parameters:
true - if display for front office or false if display for back office
Returns:
the template url

getEntryData

public java.lang.String getEntryData(javax.servlet.http.HttpServletRequest request,
                                     java.util.Locale locale)
Description copied from interface: IEntry
Get the request data

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

getRecordFieldData

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

Specified by:
getRecordFieldData in interface IEntry
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

getImportRecordFieldData

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

Specified by:
getImportRecordFieldData in interface IEntry
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

getRecordFieldData

public void getRecordFieldData(Record record,
                               java.util.List<java.lang.String> lstValue,
                               boolean bTestDirectoryError,
                               boolean bAddNewValue,
                               java.util.List<RecordField> listRecordField,
                               java.util.Locale locale)
                        throws DirectoryErrorException
Description copied from interface: IEntry
save in the list of record field the record field associate to the entry

Specified by:
getRecordFieldData in interface IEntry
lstValue - 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

getTemplateCreate

public java.lang.String getTemplateCreate()
Description copied from interface: IEntry
Get template create url

Specified by:
getTemplateCreate in interface IEntry
Returns:
template create url

getTemplateModify

public java.lang.String getTemplateModify()
Description copied from interface: IEntry
Get the template modify url

Specified by:
getTemplateModify in interface IEntry
Returns:
template modify url

getPaginator

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

Specified by:
getPaginator in interface IEntry
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

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

Specified by:
getReferenceListRegularExpression in interface IEntry
Parameters:
entry - the entry
plugin - the plugin
Returns:
the regular expression list who is use in the template modify

getHtmlFormEntry

public java.lang.String getHtmlFormEntry(java.util.Locale locale,
                                         boolean isDisplayFront)
Description copied from interface: IEntry
Get Html code used in entry form

Specified by:
getHtmlFormEntry in interface IEntry
Parameters:
locale - the locale
isDisplayFront - true if the template front or false if the template back
Returns:
html code

getHtmlFormEntry

public java.lang.String getHtmlFormEntry(java.util.Locale locale,
                                         java.util.List<RecordField> defaultValues,
                                         boolean isDisplayFront)
Description copied from interface: IEntry
Get Html code used in entry form

Specified by:
getHtmlFormEntry in interface IEntry
Parameters:
locale - the locale
defaultValues - 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

public java.lang.String getHtmlFormSearchEntry(java.util.Locale locale,
                                               boolean isDisplayFront)
Description copied from interface: IEntry
Get Html code used in search form

Specified by:
getHtmlFormSearchEntry in interface IEntry
Parameters:
locale - the locale
isDisplayFront - true if the template front or false if the template back
Returns:
html code

getHtmlFormSearchEntry

public java.lang.String getHtmlFormSearchEntry(java.util.Locale locale,
                                               java.util.List<RecordField> defaultValues,
                                               boolean isDisplayFront)
Description copied from interface: IEntry
Get Html code used in search form

Specified by:
getHtmlFormSearchEntry in interface IEntry
Parameters:
locale - the locale
defaultValues - 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

public java.lang.String getHtmlRecordFieldValue(java.util.Locale locale,
                                                RecordField recordField,
                                                boolean isDisplayFront)
Description copied from interface: IEntry
Get the Html code used in display records

Specified by:
getHtmlRecordFieldValue in interface IEntry
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

public java.lang.String convertRecordFieldValueToString(RecordField recordField,
                                                        java.util.Locale locale,
                                                        boolean bDisplayFront,
                                                        boolean bExportDirectory)
Description copied from interface: IEntry
convert the value contains in the record field to string

Specified by:
convertRecordFieldValueToString in interface IEntry
Parameters:
recordField - the recordField
locale - the locale
bDisplayFront - true if display front or false if display back
bExportDirectory - true if display export
Returns:
string

convertRecordFieldTitleToString

public java.lang.String convertRecordFieldTitleToString(RecordField recordField,
                                                        java.util.Locale locale,
                                                        boolean bDisplayFront)
Description copied from interface: IEntry
convert the title contains in the record field to string

Specified by:
convertRecordFieldTitleToString in interface IEntry
Parameters:
recordField - the recordField
locale - the locale
bDisplayFront - true if display front or false if display back
Returns:
string

addSearchCriteria

public void addSearchCriteria(java.util.HashMap<java.lang.String,java.lang.Object> mapSearchItem,
                              RecordField recordField)
Description copied from interface: IEntry
add in the search map the criteria

Specified by:
addSearchCriteria in interface IEntry
Parameters:
mapSearchItem - Search map
recordField - the record field

getXml

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

Specified by:
getXml in interface IEntry
Parameters:
plugin - plugin
locale - loclae
strXml - the string buffer

getImportRecordFieldData

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

setMapProvider

public void setMapProvider(IMapProvider mapProvider)
Sets the map provider

Specified by:
setMapProvider in interface IEntry
Parameters:
mapProvider - the map provider

getMapProvider

public IMapProvider getMapProvider()
Gets the map provider

Specified by:
getMapProvider in interface IEntry
Returns:
the map provider

isSortable

public boolean isSortable()
Check if the entry is sortable

Specified by:
isSortable in interface IEntry
Returns:
true if it is sortable, false otherwise

getPaginator

public fr.paris.lutece.portal.web.util.LocalizedPaginator getPaginator(int nItemPerPage,
                                                                       java.lang.String strBaseUrl,
                                                                       java.lang.String strPageIndexParameterName,
                                                                       java.lang.String strPageIndex,
                                                                       java.util.Locale locale)
Description copied from interface: IEntry
The paginator who is use in the template modify of the entry

Specified by:
getPaginator in interface IEntry
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
locale - Locale
Returns:
the paginator who is use in the template modify of the entry

getSQLJoin

public java.lang.String getSQLJoin()
Provide default join on directory_record_field

Specified by:
getSQLJoin in interface IEntry
Returns:
join clause (i.e " JOIN some_table ON col1=col2 ")
See Also:
IEntry.isSortable()

getSQLOrderBy

public java.lang.String getSQLOrderBy()
Provides default order by on directory_record_field.record_field_value

Specified by:
getSQLOrderBy in interface IEntry
Returns:
order by clause (i.e. " ORDER BY some_column ")
See Also:
IEntry.isSortable()

getSQLParametersValues

public java.util.List<java.lang.Object> getSQLParametersValues()
Returns the entry id

Specified by:
getSQLParametersValues in interface IEntry
Returns:
an empty list if no parameter needed, parameters values otherwise.

isIndexedAsTitle

public boolean isIndexedAsTitle()

Specified by:
isIndexedAsTitle in interface IEntry
Returns:
true if the field is (part of) the title of the document in the global index

setIndexedAsTitle

public void setIndexedAsTitle(boolean indexedAsTitle)
set true if the field is (part of) the title of the document in the global index

Specified by:
setIndexedAsTitle in interface IEntry
Parameters:
indexedAsTitle - true if the field is (part of) the title of the document in the global index

isIndexedAsSummary

public boolean isIndexedAsSummary()

Specified by:
isIndexedAsSummary in interface IEntry
Returns:
true if the field is (part of) the summary of the document in the global index

setIndexedAsSummary

public void setIndexedAsSummary(boolean indexedAsSummary)
set true if the field is (part of) the summary of the document in the global index

Specified by:
setIndexedAsSummary in interface IEntry
Parameters:
indexedAsSummary - true if the field is (part of) the summary of the document in the global index


Copyright © 2011 Mairie de Paris. All Rights Reserved.