Class CMSRecordListContent
java.lang.Object
io.goobi.viewer.model.cms.pages.content.CMSContent
io.goobi.viewer.model.cms.pages.content.types.CMSRecordListContent
- All Implemented Interfaces:
PagedCMSContent
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
exportHtmlFragment
(String outputFolderPath, String namingScheme) Writes HTML fragment value as file for re-indexing.int
Alias forgetSearch()
.getSortFieldForLanguage
(String language) IfsortField
contains a language code placeholder, this method replaces it with the give language code.getView()
handlePageLoad
(boolean resetResults, CMSComponent component) Method to call when loading a CMSPage including this content itemboolean
isEmpty()
boolean
void
setElementsPerPage
(int elementsPerPage) void
setGroupingField
(String groupingField) void
setIncludeStructureElements
(boolean includeStructureElements) void
setMetadataListType
(String metadataListType) void
setResultGroupName
(String resultGroupName) void
setSolrQuery
(String solrQuery) void
setSortField
(String sortField) void
setView
(HitListView view) Methods inherited from class io.goobi.viewer.model.cms.pages.content.CMSContent
getBackendComponentLibrary, getData, getId, getItemId, getOwningComponent, getOwningPage, isRequired, setId, setItemId, setOwningComponent, setRequired
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.goobi.viewer.model.cms.pages.content.PagedCMSContent
getCurrentListPage, getOwningComponent
-
Constructor Details
-
CMSRecordListContent
public CMSRecordListContent()
-
-
Method Details
-
getBackendComponentName
- Specified by:
getBackendComponentName
in classCMSContent
-
getSolrQuery
-
setSolrQuery
-
getGroupingField
-
setGroupingField
-
getResultGroupName
- Returns:
- the resultGroupName
-
setResultGroupName
- Parameters:
resultGroupName
- the resultGroupName to set
-
getSortField
-
getSortFieldForLanguage
IfsortField
contains a language code placeholder, this method replaces it with the give language code.- Parameters:
language
- ISO-2 language code- Returns:
- Configured sortField, placeholder replaced with given language
-
setSortField
-
isIncludeStructureElements
public boolean isIncludeStructureElements() -
setIncludeStructureElements
public void setIncludeStructureElements(boolean includeStructureElements) -
getSearch
-
getElementsPerPage
public int getElementsPerPage() -
setElementsPerPage
public void setElementsPerPage(int elementsPerPage) -
getView
-
setView
-
getMetadataListType
- Returns:
- the metadataListType
-
setMetadataListType
- Parameters:
metadataListType
- the metadataListType to set
-
copy
- Specified by:
copy
in classCMSContent
-
exportHtmlFragment
public List<File> exportHtmlFragment(String outputFolderPath, String namingScheme) throws IOException, ViewerConfigurationException Description copied from class:CMSContent
Writes HTML fragment value as file for re-indexing. HTML/text fragments are exported directly. Attached media items are exported as long as their content type is one of the supported text document formats.- Specified by:
exportHtmlFragment
in classCMSContent
- Parameters:
outputFolderPath
- aString
object.namingScheme
- aString
object.- Returns:
- Exported Files
- Throws:
IOException
- if any.ViewerConfigurationException
-
handlePageLoad
public String handlePageLoad(boolean resetResults, CMSComponent component) throws PresentationException Description copied from class:CMSContent
Method to call when loading a CMSPage including this content item- Specified by:
handlePageLoad
in classCMSContent
- Returns:
- a JSF action response
- Throws:
PresentationException
-
getData
- Specified by:
getData
in classCMSContent
- Returns:
- a string representing this contentItem for use in frontend-components. May be an empty string for content with no clear String representation
-
getFunctionality
Alias forgetSearch()
. Used in legacy templates- Returns:
Functionality
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in classCMSContent
-