|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEntry
IEntry Class
Method Summary | |
---|---|
void |
addSearchCriteria(HashMap<String,Object> mapSearchItem,
RecordField recordField)
add in the search map the criteria |
void |
canUploadFiles(List<org.apache.commons.fileupload.FileItem> listUploadedFileItems,
List<org.apache.commons.fileupload.FileItem> listFileItemsToUpload,
Locale locale)
Check if the file can be uploaded or not. |
String |
convertRecordFieldTitleToString(RecordField recordField,
Locale locale,
boolean bDisplayFront)
convert the title contains in the record field to string |
String |
convertRecordFieldValueToString(RecordField recordField,
Locale locale,
boolean bDisplayFront,
boolean bDisplayExport)
convert the value contains in the record field to string |
boolean |
getAnonymize()
Check if this entry should be anonymized when a record is anonymized. |
List<IEntry> |
getChildren()
|
String |
getComment()
|
Directory |
getDirectory()
|
int |
getDisplayHeight()
|
int |
getDisplayWidth()
|
int |
getEntryAssociate()
|
String |
getEntryData(javax.servlet.http.HttpServletRequest request,
Locale locale)
Get the request data |
EntryType |
getEntryType()
|
List<Field> |
getFields()
|
String |
getHelpMessage()
|
String |
getHelpMessageSearch()
|
String |
getHtmlFormEntry(Locale locale,
boolean isDisplayFront)
Get Html code used in entry form |
String |
getHtmlFormEntry(Locale locale,
List<RecordField> listRecordField,
boolean isDisplayFront)
Get Html code used in entry form |
String |
getHtmlFormSearchEntry(Locale locale,
boolean isDisplayFront)
Get Html code used in search form |
String |
getHtmlFormSearchEntry(Locale locale,
List<RecordField> listRecordField,
boolean isDisplayFront)
Get Html code used in search form |
String |
getHtmlRecordFieldValue(Locale locale,
RecordField recordField,
boolean isDisplayFront)
Get the Html code used in display records |
int |
getIdEntry()
|
void |
getImportRecordFieldData(Record record,
byte[] decodedBytes,
String nomFile,
boolean b,
List<RecordField> listRecordField,
Locale locale)
|
void |
getImportRecordFieldData(Record record,
String strImportValue,
boolean bTestDirectoryError,
List<RecordField> listRecordField,
Locale locale)
save in the list of record field the record field associate to the entry |
String |
getLabelValueAllSearch()
|
IMapProvider |
getMapProvider()
Gets the map provider |
fr.paris.lutece.util.html.Paginator |
getPaginator(int nItemPerPage,
String strBaseUrl,
String strPageIndexParameterName,
String strPageIndex)
The paginator who is use in the template modify of the entry |
fr.paris.lutece.portal.web.util.LocalizedPaginator |
getPaginator(int nItemPerPage,
String strBaseUrl,
String strPageIndexParameterName,
String strPageIndex,
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,
List<RecordField> listRecordField,
Locale locale)
save in the list of record field the record field associate to the entry |
void |
getRecordFieldData(Record record,
List<String> listValue,
boolean bTestDirectoryError,
boolean bAddNewValue,
List<RecordField> listRecordField,
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 |
String |
getRequestSQL()
|
String |
getSQLJoin()
Gets the join clause for SQL in case of query order. |
String |
getSQLOrderBy()
Gets the order by clause in case of query order. |
List<Object> |
getSQLParametersValues()
Use with getSQLJoin() and getSQLOrderBy() to add parameters values |
String |
getTemplateCreate()
Get template create url |
String |
getTemplateModify()
Get the template modify url |
String |
getTitle()
|
void |
getXml(fr.paris.lutece.portal.service.plugin.Plugin plugin,
Locale locale,
StringBuffer strXml)
add The Xml of the entry in the string buffer |
boolean |
isAddValueAllSearch()
|
boolean |
isAnonymizable()
Check if entries of this type are anonymizable or not. |
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 |
setAnonymize(boolean bAnonymize)
Set the anonymize status of an entry. |
void |
setAutocompleteEntry(boolean bIsAutocompleEntry)
set autocomplete entry type |
void |
setChildren(List<IEntry> children)
set the list of entry who are insert in the group |
void |
setComment(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(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(String helpMessage)
set entry help message |
void |
setHelpMessageSearch(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(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(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(String title)
set title entry |
void |
setWorkgroupAssociated(boolean bWorkGroupAssociated)
set true if a workgroup can be associated with a item |
Method Detail |
---|
int getIdEntry()
void setIdEntry(int idEntry)
idEntry
- the id of the entryDirectory getDirectory()
void setDirectory(Directory directory)
directory
- the directory associate to the entryString getTitle()
void setTitle(String title)
title
- titleString getHelpMessage()
void setHelpMessage(String helpMessage)
helpMessage
- entry helpMessageString getHelpMessageSearch()
void setHelpMessageSearch(String helpMessage)
helpMessage
- the entry help message for searchString getComment()
void setComment(String comment)
comment
- entry commentboolean isMandatory()
void setMandatory(boolean mandatory)
mandatory
- true if the question is mandatoryboolean isFieldInLine()
void setFieldInLine(boolean fieldInLine)
fieldInLine
- true if the field associate must be display in lineboolean isShownInAdvancedSearch()
boolean isShownInResultList()
void setShownInResultList(boolean shown)
shown
- true if the entry must be shown in result list pageboolean isShownInResultRecord()
void setShownInResultRecord(boolean shown)
shown
- true if the entry must be shown in result record pageboolean isShownInHistory()
void setShownInHistory(boolean shown)
shown
- true if the entry must be shown in history pagevoid setShownInAdvancedSearch(boolean shown)
shown
- true if the entry must be shown in advanced searchboolean isShownInExport()
void setShownInExport(boolean shown)
shown
- true if the entry must be shown in data exportboolean isShownInCompleteness()
void setShownInCompleteness(boolean shown)
shown
- true if the entry must be shown in record completenessboolean isIndexed()
void setIndexed(boolean indexed)
indexed
- true if the field must be indexedboolean isIndexedAsTitle()
void setIndexedAsTitle(boolean indexedAsTitle)
indexedAsTitle
- true if the field is (part of) the title of the document in the global indexboolean isIndexedAsSummary()
void setIndexedAsSummary(boolean indexedAsSummary)
indexedAsSummary
- true if the field is (part of) the summary of the document in the global indexint getPosition()
void setPosition(int position)
position
- position entryEntryType getEntryType()
void setEntryType(EntryType entryType)
entryType
- the type of the entryList<Field> getFields()
void setFields(List<Field> fields)
fields
- the list of fieldIEntry getParent()
void setParent(IEntry parent)
parent
- parent entryList<IEntry> getChildren()
void setChildren(List<IEntry> children)
children
- the list of entryboolean isLastInTheList()
void setLastInTheList(boolean lastInTheList)
lastInTheList
- true if the entry is the last entry of a group or the list of entryboolean isFirstInTheList()
void setFirstInTheList(boolean firstInTheList)
firstInTheList
- true if the entry is the last entry of a group or the list of entryint getDisplayWidth()
void setDisplayWidth(int width)
width
- width of the entryint getDisplayHeight()
void setDisplayHeight(int height)
height
- the height of the entryboolean isRoleAssociated()
void setRoleAssociated(boolean bRoleAssociated)
bRoleAssociated
- true if a role can be associated with a itemboolean isWorkgroupAssociated()
void setWorkgroupAssociated(boolean bWorkGroupAssociated)
bWorkGroupAssociated
- true if a workgroup can be associated with a itemboolean isMultipleSearchFields()
void setMultipleSearchFields(boolean multipleSearchFields)
multipleSearchFields
- true if the entry is display with Multiple search fieldint getEntryAssociate()
void setEntryAssociate(int idEntryAssociate)
idEntryAssociate
- id entryString getRequestSQL()
void setRequestSQL(String strRequestSQL)
strRequestSQL
- request SQLboolean isAddValueAllSearch()
void setAddValueAllSearch(boolean bAddValueAllSearch)
strRequestSQL
- request SQLboolean isAutocompleteEntry()
void setAutocompleteEntry(boolean bIsAutocompleEntry)
bIsAutocompleEntry
- String getLabelValueAllSearch()
void setLabelValueAllSearch(String strLabelValueAllSearch)
request
- HttpRequestlocale
- the localeString getEntryData(javax.servlet.http.HttpServletRequest request, Locale locale)
request
- HttpRequestlocale
- the locale
void getRecordFieldData(Record record, javax.servlet.http.HttpServletRequest request, boolean bTestDirectoryError, boolean bAddNewValue, List<RecordField> listRecordField, Locale locale) throws DirectoryErrorException
record
- the record associated to the record fieldrequest
- HttpRequestbTestDirectoryError
- true if the value contains in the request must be testedlistRecordField
- the list of record field associate to the recordlocale
- the locale
DirectoryErrorException
void getRecordFieldData(Record record, List<String> listValue, boolean bTestDirectoryError, boolean bAddNewValue, List<RecordField> listRecordField, Locale locale) throws DirectoryErrorException
listValue
- the list which contains the string value of the record fieldbTestDirectoryError
- true if the value contains in the request must be testedlistRecordField
- the list of record field associate to the recordlocale
- the locale
DirectoryErrorException
void getImportRecordFieldData(Record record, String strImportValue, boolean bTestDirectoryError, List<RecordField> listRecordField, Locale locale) throws DirectoryErrorException
record
- the record associated to the record fieldstrImportValue
- the import string which contains the string value of the record fieldbTestDirectoryError
- true if the value contains in the request must be testedlistRecordField
- the list of record field associate to the recordlocale
- the locale
DirectoryErrorException
String getTemplateCreate()
String getTemplateModify()
fr.paris.lutece.util.html.Paginator getPaginator(int nItemPerPage, String strBaseUrl, String strPageIndexParameterName, String strPageIndex)
nItemPerPage
- Number of items to display per pagestrBaseUrl
- The base Url for build links on each page linkstrPageIndexParameterName
- The parameter name for the page indexstrPageIndex
- The current page index
fr.paris.lutece.util.ReferenceList getReferenceListRegularExpression(IEntry entry, fr.paris.lutece.portal.service.plugin.Plugin plugin)
plugin
- the pluginentry
- the entry
String getHtmlFormEntry(Locale locale, boolean isDisplayFront)
locale
- the localeisDisplayFront
- true if the template front or false if the template back
String getHtmlFormEntry(Locale locale, List<RecordField> listRecordField, boolean isDisplayFront)
locale
- the localelistRecordField
- the list of record field associate to the entryisDisplayFront
- true if the template front or false if the template back
String getHtmlFormSearchEntry(Locale locale, boolean isDisplayFront)
locale
- the localeisDisplayFront
- true if the template front or false if the template back
String getHtmlFormSearchEntry(Locale locale, List<RecordField> listRecordField, boolean isDisplayFront)
locale
- the localelistRecordField
- the list of record field associate to the entryisDisplayFront
- true if the template front or false if the template back
String getHtmlRecordFieldValue(Locale locale, RecordField recordField, boolean isDisplayFront)
locale
- the localerecordField
- the record field associate to the entryisDisplayFront
- true if the template front or false if the template back
String convertRecordFieldValueToString(RecordField recordField, Locale locale, boolean bDisplayFront, boolean bDisplayExport)
recordField
- the recordFieldlocale
- the localebDisplayFront
- true if display front or false if display backbDisplayExport
- true if display export
String convertRecordFieldTitleToString(RecordField recordField, Locale locale, boolean bDisplayFront)
recordField
- the recordFieldlocale
- the localebDisplayFront
- true if display front or false if display back
void addSearchCriteria(HashMap<String,Object> mapSearchItem, RecordField recordField)
recordField
- the record fieldmapSearchItem
- Search mapvoid getXml(fr.paris.lutece.portal.service.plugin.Plugin plugin, Locale locale, StringBuffer strXml)
plugin
- pluginlocale
- loclaestrXml
- the string buffervoid getImportRecordFieldData(Record record, byte[] decodedBytes, String nomFile, boolean b, List<RecordField> listRecordField, Locale locale) throws DirectoryErrorException
DirectoryErrorException
void setMapProvider(IMapProvider mapProvider)
mapProvider
- the map providerIMapProvider getMapProvider()
boolean isSortable()
fr.paris.lutece.portal.web.util.LocalizedPaginator getPaginator(int nItemPerPage, String strBaseUrl, String strPageIndexParameterName, String strPageIndex, Locale locale)
nItemPerPage
- Number of items to display per pagestrBaseUrl
- The base Url for build links on each page linkstrPageIndexParameterName
- The parameter name for the page indexstrPageIndex
- The current page indexlocale
- Locale
String getSQLJoin()
" JOIN some_table ON col1=col2 "
)isSortable()
String getSQLOrderBy()
" ORDER BY some_column "
)isSortable()
List<Object> getSQLParametersValues()
getSQLJoin()
and getSQLOrderBy()
to add parameters values
void canUploadFiles(List<org.apache.commons.fileupload.FileItem> listUploadedFileItems, List<org.apache.commons.fileupload.FileItem> listFileItemsToUpload, Locale locale) throws DirectoryErrorException
listUploadedFileItems
- the list of uploaded fileslistFileItemsToUpload
- the list of files to uploadlocale
- the locale
DirectoryErrorException
- exception if there is an errorboolean getAnonymize()
void setAnonymize(boolean bAnonymize)
bAnonymize
- True if this entry should be anonymized when a record
is anonymized, false otherwiseboolean isAnonymizable()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |