Package io.goobi.viewer.model.cms

Class CMSNavigationManager

java.lang.Object

io.goobi.viewer.model.cms.CMSNavigationManager

All Implemented Interfaces:

Serializable

public class CMSNavigationManager
extends Object
implements Serializable

CMSNavigationManager class.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CMSNavigationManager(String associatedTheme)	Constructor for CMSNavigationManager.

Method Summary

Modifier and Type	Method	Description
void	addAvailableItem(SelectableNavigationItem item)	addAvailableItem.
void	addCMSPageItems()	addCMSPageItems.
void	addSelectedItemsToMenu()	Add all items from availableItems to visibleItems for which SelectableNavigationItem.isSelected() is true.
void	addVisibleItem(CMSNavigationItem navigationItem)	addVisibleItem.
String	getAssociatedTheme()	Getter for the field associatedTheme.
List<SelectableNavigationItem>	getAvailableItems()	Getter for the field availableItems.
Optional<CMSNavigationItem>	getItem(String id)	getItem.
List<CMSNavigationItem>	getVisibleItems()	Getter for the field visibleItems.
final void	loadItems()	loadItems.
List<CMSNavigationItem>	loadItemsFromDatabase()	loadItemsFromDatabase.
final List<CMSNavigationItem>	loadVisibleItems()	loadVisibleItems.
void	reload()	reload.
void	saveVisibleItems(String theme)	Replaces the complete navigation-item database table with the elements of 'visibleItems'
void	setVisibleItems(List<CMSNavigationItem> items)	Adds the given item, along with all their descendants to the visible item list

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CMSNavigationManager

public CMSNavigationManager(String associatedTheme)

Constructor for CMSNavigationManager.

Parameters:

associatedTheme - a String object.

Method Details

loadItems

public final void loadItems()
                     throws DAOException

loadItems.

Throws:

DAOException - if any.

addCMSPageItems

public void addCMSPageItems()
                     throws DAOException

addCMSPageItems.

Throws:

DAOException - if any.

addAvailableItem

public void addAvailableItem(SelectableNavigationItem item)

addAvailableItem.

Parameters:

item - a SelectableNavigationItem object.

getAvailableItems

public List<SelectableNavigationItem> getAvailableItems()

Getter for the field availableItems.

Returns:

a List object.

addSelectedItemsToMenu

public void addSelectedItemsToMenu()

Add all items from availableItems to visibleItems for which SelectableNavigationItem.isSelected() is true. Afterwards sets SelectableNavigationItem.isSelected() to fals for all availableItems

loadVisibleItems

public final List<CMSNavigationItem> loadVisibleItems()
                                               throws DAOException

loadVisibleItems.

Returns:

the sublist of available menu items matching the navigationMenuItem-list from the database (in label and url)

Throws:

DAOException - if any.

loadItemsFromDatabase

public List<CMSNavigationItem> loadItemsFromDatabase()
                                              throws DAOException

loadItemsFromDatabase.

Returns:

a List object.

Throws:

DAOException - if any.

getVisibleItems

public List<CMSNavigationItem> getVisibleItems()

Getter for the field visibleItems.

Returns:

a List object.

setVisibleItems

public void setVisibleItems(List<CMSNavigationItem> items)

Adds the given item, along with all their descendants to the visible item list

Parameters:

items - a List object.

saveVisibleItems

public void saveVisibleItems(String theme)
                      throws DAOException

Replaces the complete navigation-item database table with the elements of 'visibleItems'

Parameters:

theme - a String object.

Throws:

DAOException - if any.

addVisibleItem

public void addVisibleItem(CMSNavigationItem navigationItem)

addVisibleItem.

Parameters:

navigationItem - a CMSNavigationItem object.

reload

public void reload()
            throws DAOException

reload.

Throws:

DAOException - if any.

getItem

public Optional<CMSNavigationItem> getItem(String id)

getItem.

Parameters:

id - the item's CMSNavigationItem.getSortingListId()

Returns:

The first matching item from all visible items as optional. Empty optional if no matching item was found

getAssociatedTheme

public String getAssociatedTheme()

Getter for the field associatedTheme.

Returns:

the associatedTheme