Package com.logicaldoc.gui.frontend.client.services

Interface DashletService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

DashletServiceImpl

@RemoteServiceRelativePath("dashlet")
public interface DashletService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Dashlet Service. This service allows the handling of dashlets.

Since:

8.2.3

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DashletService.Instance

Method Summary

Modifier and Type	Method	Description
void	delete(long dashletId)
GUIDashlet	get(long dashletId)	Gets a dashlet
GUIDashlet	get(String name)	Gets a dashlet
GUIDashlet[]	loadDashlets()	Loads all the dashlet definitions
void	save(GUIDashlet dashlet)	Saves a dashlet
void	saveDashlets(GUIDashlet[] dashlets)	Saves the dashlet definitions
void	saveUserDashlets(GUIDashlet[] dashlets)	Saves the user's dashlet configuration

Method Detail

save

void save(GUIDashlet dashlet)
   throws ServerException

Saves a dashlet

Parameters:

dashlet - the dashlet to save

Throws:

ServerException - an error happened in the server application

get

GUIDashlet get(long dashletId)
        throws ServerException

Gets a dashlet

Parameters:

dashletId - identifier of the dashlet

Returns:

the dashlet retrieved by the server application

Throws:

ServerException - an error happened in the server application

saveDashlets

void saveDashlets(GUIDashlet[] dashlets)
           throws ServerException

Saves the dashlet definitions

Parameters:

dashlets - the dashlets to save

Throws:

ServerException - an error happened in the server application

loadDashlets

GUIDashlet[] loadDashlets()
                   throws ServerException

Loads all the dashlet definitions

Returns:

all the dashlets

Throws:

ServerException - an error happened in the server application

saveUserDashlets

void saveUserDashlets(GUIDashlet[] dashlets)
               throws ServerException

Saves the user's dashlet configuration

Parameters:

dashlets - the dashlets to save

Throws:

ServerException - an error happened in the server application

get

GUIDashlet get(String name)
        throws ServerException

Gets a dashlet

Parameters:

name - the name of the dashlet

Returns:

the dashlet retrieved by the server application

Throws:

ServerException - an error happened in the server application

delete

void delete(long dashletId)
     throws ServerException

Throws:

ServerException