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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
changeAdminPassword
(String password, String tenantName) Changes the password of the administrator of the given tenantchangeSessionTenant
(long tenantId) Change session tenantvoid
delete
(long tenantId) Deletes a specific tenant by its IDEncodes the uploaded branding imageImports the uploaded branding packageload
(long tenantId) Loads a given tenantSaves/Updates a given tenant
-
Method Details
-
delete
Deletes a specific tenant by its ID- Parameters:
tenantId
- identifier of the tenant- Throws:
ServerException
- an error happened in the server application
-
save
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
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
Changes the password of the administrator of the given tenant- Parameters:
password
- the new password for the administrator usertenantName
- name of the tenant- Throws:
ServerException
- an error happened in the server application
-
changeSessionTenant
Change session tenant- Parameters:
tenantId
- identifier of the tenant- Returns:
- the selected tenant
- Throws:
ServerException
- an error happened in the server application
-
encodeBrandingImage
Encodes the uploaded branding image- Returns:
- the Base64 image used for the brand
- Throws:
ServerException
- an error happened in the server application
-
importBrandingPackage
Imports the uploaded branding package- Returns:
- the branding representation
- Throws:
ServerException
- an error happened in the server application
-