Package com.logicaldoc.gui.common.client.services

Interface InfoService

All Superinterfaces:

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

All Known Implementing Classes:

InfoServiceImpl

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

Informations service

Since:

6.0.0

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	InfoService.Instance

Method Summary

Modifier and Type	Method	Description
String	getCronDescription(String expression, String locale)	Retrieves the natural language description of a given cron expression
GUIInfo	getInfo(String locale, String tenant, boolean login)	Retrieves the system informations
List<GUIParameter>	getSessionInfo()	Retrieves all the settings for the current session
boolean	ping()	Ping to maintain open he session

Method Details

getInfo

GUIInfo getInfo(String locale,
 String tenant,
 boolean login)
         throws ServerException

Retrieves the system informations

Parameters:

locale - language to use

tenant - name of the tenant

login - if the informations are asked by the login form

Returns:

the User Inteface's informations

Throws:

ServerException - raised in case of error in the server

getSessionInfo

List<GUIParameter> getSessionInfo()
                           throws InvalidSessionServerException

Retrieves all the settings for the current session

Returns:

all the settings

Throws:

InvalidSessionServerException - the session does not exist or is expired

getCronDescription

String getCronDescription(String expression,
 String locale)
                   throws ServerException

Retrieves the natural language description of a given cron expression

Parameters:

expression - the cron expression to evaluate

locale - the locale to use for the description

Returns:

the natural language description

Throws:

ServerException - raised in case the given expression is invalid

ping

boolean ping()
      throws InvalidSessionServerException

Ping to maintain open he session

Returns:

if the server has been successfully contacted

Throws:

InvalidSessionServerException - the session does not exist or is expired