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

Interface TenantService

All Superinterfaces:

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

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

The client side stub for the Tenant Service. This service allows r/w operations on tenants.

Since:

6.9

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TenantService.Instance

Method Summary

Modifier and Type	Method	Description
void	changeAdminPassword(String password, String tenantName)	Changes the password of the administrator of the given tenant
GUITenant	changeSessionTenant(long tenantId)	Change session tenant
void	delete(long tenantId)	Deletes a specific tenant by its ID
String	encodeBrandingImage()	Encodes the uploaded branding image
GUIBranding	importBrandingPackage()	Imports the uploaded branding package
GUITenant	load(long tenantId)	Loads a given tenant
GUITenant	save(GUITenant tenant)	Saves/Updates a given tenant

Method Detail

delete

void delete(long tenantId)
     throws ServerException

Deletes a specific tenant by its ID

Parameters:

tenantId - identifier of the tenant

Throws:

ServerException - an error happened in the server application

save

GUITenant save(GUITenant tenant)
        throws ServerException

Saves/Updates a given tenant

Parameters:

tenant - the tenant to save

Returns:

the saved tenant

Throws:

ServerException - an error happened in the server application

load

GUITenant load(long tenantId)
        throws ServerException

Loads a given tenant

Parameters:

tenantId - identifier of the tenant

Returns:

the tenant retrieved by the server application

Throws:

ServerException - an error happened in the server application

changeAdminPassword

void changeAdminPassword(String password,
                         String tenantName)
                  throws ServerException

Changes the password of the administrator of the given tenant

Parameters:

password - the new password for the administrator user

tenantName - name of the tenant

Throws:

ServerException - an error happened in the server application

changeSessionTenant

GUITenant changeSessionTenant(long tenantId)
                       throws ServerException

Change session tenant

Parameters:

tenantId - identifier of the tenant

Returns:

the selected tenant

Throws:

ServerException - an error happened in the server application

encodeBrandingImage

String encodeBrandingImage()
                    throws ServerException

Encodes the uploaded branding image

Returns:

the Base64 image used for the brand

Throws:

ServerException - an error happened in the server application

importBrandingPackage

GUIBranding importBrandingPackage()
                           throws ServerException

Imports the uploaded branding package

Returns:

the branding representation

Throws:

ServerException - an error happened in the server application