com.broadleafcommerce.advancedcms.service

Interface WidgetService

All Known Implementing Classes:

WidgetServiceImpl

public interface WidgetService

Service methods for Widgets

Author:

Andre Azzolini (apazzolini)

Method Summary

Methods

Modifier and Type	Method and Description
List<Widget>	findAllActiveWidgets()
List<Widget>	findAllCurrentlyUsedWidgets() Returns a list of widgets such that each widget in the list is used by at least one ContentItem.
List<ContentItem>	findContentItemsByWidgetId(Long id) Finds all Content Items which use the Widget by its internal database id
Widget	findWidgetById(Long id) Finds a Widget instance by its internal database id
Widget	saveWidget(Widget widget) Persists the given widget to the database.

Method Detail

findAllActiveWidgets

List<Widget> findAllActiveWidgets()

Returns:

a list of all currently active widgets

findAllCurrentlyUsedWidgets

List<Widget> findAllCurrentlyUsedWidgets()

Returns a list of widgets such that each widget in the list is used by at least one ContentItem.

Returns:

a list of all currently used widgets

findWidgetById

Widget findWidgetById(Long id)

Finds a Widget instance by its internal database id

Parameters:

id -

Returns:

the Widget

findContentItemsByWidgetId

List<ContentItem> findContentItemsByWidgetId(Long id)

Finds all Content Items which use the Widget by its internal database id

Parameters:

id -

Returns:

the list of Items

saveWidget

Widget saveWidget(Widget widget)

Persists the given widget to the database.

Parameters:

widget -

Returns:

the persisted widget