org.graylog2.dashboards

Interface DashboardService

All Superinterfaces:

PersistedService

All Known Implementing Classes:

DashboardServiceImpl

public interface DashboardService
extends PersistedService

Method Summary

Modifier and Type	Method and Description
void	addWidget(Dashboard dashboard, DashboardWidget widget)
List<Dashboard>	all()
long	count()
Dashboard	create(String title, String description, String creatorUserId, org.joda.time.DateTime createdAt)
int	destroy(Dashboard model)
Dashboard	load(String id)
Set<Dashboard>	loadByIds(Collection<String> ids)
void	removeWidget(Dashboard dashboard, DashboardWidget widget)
void	updateWidgetCacheTime(Dashboard dashboard, DashboardWidget widget, int cacheTime) Deprecated.
void	updateWidgetDescription(Dashboard dashboard, DashboardWidget widget, String newDescription) Deprecated.
void	updateWidgetPositions(Dashboard dashboard, WidgetPositionsRequest positions)

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

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

Method Detail

create

Dashboard create(String title,
                 String description,
                 String creatorUserId,
                 org.joda.time.DateTime createdAt)

load

Dashboard load(String id)
        throws NotFoundException

Throws:

NotFoundException

all

List<Dashboard> all()

loadByIds

Set<Dashboard> loadByIds(Collection<String> ids)

updateWidgetPositions

void updateWidgetPositions(Dashboard dashboard,
                           WidgetPositionsRequest positions)
                    throws ValidationException

Throws:

ValidationException

addWidget

void addWidget(Dashboard dashboard,
               DashboardWidget widget)
        throws ValidationException

Throws:

ValidationException

removeWidget

void removeWidget(Dashboard dashboard,
                  DashboardWidget widget)

updateWidgetDescription

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

Deprecated.

Throws:

ValidationException

updateWidgetCacheTime

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

Deprecated.

Throws:

ValidationException

count

long count()

Returns:

the total number of dashboards

destroy

int destroy(Dashboard model)