org.graylog2.dashboards

Interface DashboardService

All Superinterfaces:

PersistedService

All Known Implementing Classes:

DashboardServiceImpl

public interface DashboardService
extends PersistedService

Method Summary

Methods

Modifier and Type	Method and Description
void	addWidget(Dashboard dashboard, DashboardWidget widget)
List<Dashboard>	all()
long	count()
Dashboard	load(String id)
void	removeWidget(Dashboard dashboard, DashboardWidget widget)
void	updateWidgetCacheTime(Dashboard dashboard, DashboardWidget widget, int cacheTime)
void	updateWidgetDescription(Dashboard dashboard, DashboardWidget widget, String newDescription)
void	updateWidgetPositions(Dashboard dashboard, WidgetPositions positions)

Methods inherited from interface org.graylog2.plugin.database.PersistedService

destroy, destroyAll, save, saveWithoutValidation, validate, validate, validate

Method Detail

load

Dashboard load(String id)
               throws NotFoundException

Throws:

NotFoundException

all

List<Dashboard> all()

updateWidgetPositions

void updateWidgetPositions(Dashboard dashboard,
                         WidgetPositions positions)
                           throws ValidationException

Throws:

ValidationException

addWidget

void addWidget(Dashboard dashboard,
             DashboardWidget widget)
               throws ValidationException

Throws:

ValidationException

removeWidget

void removeWidget(Dashboard dashboard,
                DashboardWidget widget)

updateWidgetDescription

void updateWidgetDescription(Dashboard dashboard,
                           DashboardWidget widget,
                           String newDescription)
                             throws ValidationException

Throws:

ValidationException

updateWidgetCacheTime

void updateWidgetCacheTime(Dashboard dashboard,
                         DashboardWidget widget,
                         int cacheTime)
                           throws ValidationException

Throws:

ValidationException

count

long count()

Returns:

the total number of dashboards