Package io.goobi.viewer.model.cms.pages.content.types

Class CMSSearchContent

java.lang.Object

io.goobi.viewer.model.cms.pages.content.CMSContent

io.goobi.viewer.model.cms.pages.content.types.CMSSearchContent

All Implemented Interfaces:

PagedCMSContent

@Entity
public class CMSSearchContent
extends CMSContent
implements PagedCMSContent

Constructor Summary

Constructors

Constructor	Description
CMSSearchContent()
CMSSearchContent(CMSSearchContent orig)

Method Summary

Modifier and Type	Method	Description
CMSContent	copy()
List<File>	exportHtmlFragment(String outputFolderPath, String namingScheme)	Writes HTML fragment value as file for re-indexing.
String	getBackendComponentName()
String	getData(Integer w, Integer h)
int	getElementsPerPage()
Functionality	getFunctionality()	Alias for getSearch().
SearchFunctionality	getSearch()
String	getSearchPrefix()
String	getSortField()
HitListView	getView()
String	handlePageLoad(boolean resetResults, CMSComponent component)	Method to call when loading a CMSPage including this content item
boolean	isDisplayEmptySearchResults()
boolean	isEmpty()
void	setDisplayEmptySearchResults(boolean displayEmptySearchResults)
void	setElementsPerPage(int elementsPerPage)
void	setSearchPrefix(String searchPrefix)
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

CMSSearchContent

public CMSSearchContent()

CMSSearchContent

public CMSSearchContent(CMSSearchContent orig)

Method Details

setSearchPrefix

public void setSearchPrefix(String searchPrefix)

getSearchPrefix

public String getSearchPrefix()

setDisplayEmptySearchResults

public void setDisplayEmptySearchResults(boolean displayEmptySearchResults)

isDisplayEmptySearchResults

public boolean isDisplayEmptySearchResults()

getSearch

public SearchFunctionality getSearch()

getView

public HitListView getView()

setView

public void setView(HitListView view)

getBackendComponentName

public String getBackendComponentName()

Specified by:

getBackendComponentName in class CMSContent

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

getElementsPerPage

public int getElementsPerPage()

setElementsPerPage

public void setElementsPerPage(int elementsPerPage)

getSortField

public String getSortField()

setSortField

public void setSortField(String sortField)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class CMSContent