Package io.goobi.viewer.model.cms.widgets

Class RssFeedSidebarWidget

java.lang.Object

io.goobi.viewer.model.cms.widgets.CustomSidebarWidget

io.goobi.viewer.model.cms.widgets.RssFeedSidebarWidget

All Implemented Interfaces:

IPolyglott, Serializable

@Entity
public class RssFeedSidebarWidget
extends CustomSidebarWidget

A subtype of CustomSidebarWidget to display a RSS feed of selected records. The default settings show a list of the five last imported records

Author:

Florian Alpers

See Also:

• Serialized Form

Field Summary

Fields inherited from class io.goobi.viewer.model.cms.widgets.CustomSidebarWidget

id

Constructor Summary

Constructors

Constructor	Description
RssFeedSidebarWidget()	Empty default constructor.
RssFeedSidebarWidget(RssFeedSidebarWidget o)	Cloning constructor.

Method Summary

Modifier and Type	Method	Description
String	getFilterQuery()	If this query is not empty only records matching this SOLR query are listed.
int	getNumEntries()	The number of entries to display.
String	getSortField()	A SOLR field to select and sort the listed entries by.
CustomWidgetType	getType()	Return the type of this custom sidebar widget.
boolean	isDescendingSorting()	Returns whether records are sorted in descending order.
void	setDescendingSorting(boolean descendingSorting)	Set the descending sorting.
void	setFilterQuery(String filterQuery)	Set the filter query.
void	setNumEntries(int numEntries)	Sets the number of entries to display.
void	setSortField(String sortField)	Set the sort field.

Methods inherited from class io.goobi.viewer.model.cms.widgets.CustomSidebarWidget

clone, getAdminBackendUrl, getDescription, getId, getSelectedLocale, getShortDescription, getStyleClass, getTitle, isCollapsed, isComplete, isEmpty, isHasShortDescription, isValid, setCollapsed, setId, setSelectedLocale, setStyleClass, setTitle

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.translations.IPolyglott

getLocales, isDefaultLocaleSelected, isSelected, setSelectedLocale

Constructor Details

RssFeedSidebarWidget

public RssFeedSidebarWidget()

Empty default constructor.

RssFeedSidebarWidget

public RssFeedSidebarWidget(RssFeedSidebarWidget o)

Cloning constructor.

Parameters:

o - widget instance to clone

Method Details

getFilterQuery

public String getFilterQuery()

If this query is not empty only records matching this SOLR query are listed.

Returns:

the Solr filter query restricting which RSS feed entries are shown, or an empty string if no filter is set

setFilterQuery

public void setFilterQuery(String filterQuery)

Set the filter query.

Parameters:

filterQuery - the Solr filter query to restrict which RSS feed entries are shown

getSortField

public String getSortField()

A SOLR field to select and sort the listed entries by.

Returns:

the Solr field name used for sorting RSS feed entries

setSortField

public void setSortField(String sortField)

Set the sort field.

Parameters:

sortField - the Solr field name to sort the RSS feed entries by

isDescendingSorting

public boolean isDescendingSorting()

Returns whether records are sorted in descending order.

Returns:

true if entries are sorted in descending order, false otherwise

setDescendingSorting

public void setDescendingSorting(boolean descendingSorting)

Set the descending sorting.

Parameters:

descendingSorting - true to sort entries in descending order, false for ascending

getNumEntries

public int getNumEntries()

The number of entries to display.

Returns:

The number of entries to display

setNumEntries

public void setNumEntries(int numEntries)

Sets the number of entries to display.

Parameters:

numEntries - the maximum number of RSS feed entries to show in the widget

getType

public CustomWidgetType getType()

Description copied from class: CustomSidebarWidget

Return the type of this custom sidebar widget. Must be implemented by subclasses of CustomSidebarWidget

Overrides:

getType in class CustomSidebarWidget

Returns:

CustomWidgetType