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

@Entity public class CMSRecordListContent extends CMSContent implements PagedCMSContent
  • Constructor Details

    • CMSRecordListContent

      public CMSRecordListContent()
  • Method Details

    • getBackendComponentName

      public String getBackendComponentName()
      Specified by:
      getBackendComponentName in class CMSContent
    • getSolrQuery

      public String getSolrQuery()
    • setSolrQuery

      public void setSolrQuery(String solrQuery)
    • getGroupingField

      public String getGroupingField()
    • setGroupingField

      public void setGroupingField(String groupingField)
    • getResultGroupName

      public String getResultGroupName()
      Returns:
      the resultGroupName
    • setResultGroupName

      public void setResultGroupName(String resultGroupName)
      Parameters:
      resultGroupName - the resultGroupName to set
    • getSortField

      public String getSortField()
    • getSortFieldForLanguage

      public String getSortFieldForLanguage(String language)
      If sortField 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

      public void setSortField(String sortField)
    • isIncludeStructureElements

      public boolean isIncludeStructureElements()
    • setIncludeStructureElements

      public void setIncludeStructureElements(boolean includeStructureElements)
    • getSearch

      public SearchFunctionality getSearch()
    • getElementsPerPage

      public int getElementsPerPage()
    • setElementsPerPage

      public void setElementsPerPage(int elementsPerPage)
    • getView

      public HitListView getView()
    • setView

      public void setView(HitListView view)
    • getMetadataListType

      public String getMetadataListType()
      Returns:
      the metadataListType
    • setMetadataListType

      public void setMetadataListType(String metadataListType)
      Parameters:
      metadataListType - the metadataListType to set
    • copy

      public CMSContent copy()
      Specified by:
      copy in class CMSContent
    • 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 class CMSContent
      Parameters:
      outputFolderPath - a String object.
      namingScheme - a String 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 class CMSContent
      Returns:
      a JSF action response
      Throws:
      PresentationException
    • getData

      public String getData(Integer w, Integer h)
      Specified by:
      getData in class CMSContent
      Returns:
      a string representing this contentItem for use in frontend-components. May be an empty string for content with no clear String representation
    • getFunctionality

      public Functionality getFunctionality()
      Alias for getSearch(). Used in legacy templates
      Returns:
      Functionality
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in class CMSContent