Class SoapTenantClient

  • All Implemented Interfaces:
    TenantService

    public class SoapTenantClient
    extends com.logicaldoc.webservice.soap.client.SoapClient<TenantService>
    implements TenantService
    Tenant Web Service client.
    Since:
    7.0.1
    Author:
    Marco Meschieri - LogicalDOC
    • Method Detail

      • getTenant

        public WSTenant getTenant​(String sid,
                                  String name)
                           throws Exception
        Description copied from interface: TenantService
        Gets a specific tenant by it's name
        Specified by:
        getTenant in interface TenantService
        Parameters:
        sid - identifier of the session
        name - The tenant's name
        Returns:
        A value object containing the tenant metadata.
        Throws:
        Exception - database error
      • getTenantById

        public WSTenant getTenantById​(String sid,
                                      long tenantId)
                               throws Exception
        Description copied from interface: TenantService
        Gets a specific tenant by it's identifier
        Specified by:
        getTenantById in interface TenantService
        Parameters:
        sid - identifier of the session
        tenantId - identifier of the tenant
        Returns:
        A value object containing the tenant metadata.
        Throws:
        Exception - database error
      • storeTenant

        public long storeTenant​(String sid,
                                WSTenant tenant)
                         throws Exception
        Description copied from interface: TenantService
        Create/Update a tenant. You can completely customize the tenant through a value object.
        Specified by:
        storeTenant in interface TenantService
        Parameters:
        sid - identifier of the session (need to be administrator)
        tenant - Web service value object containing the tenant's metadata
        Returns:
        The value object containing the tenant's metadata.
        Throws:
        Exception - database error
      • deleteTenant

        public void deleteTenant​(String sid,
                                 long tenantId)
                          throws Exception
        Description copied from interface: TenantService
        Deletes an existing tenant.
        Specified by:
        deleteTenant in interface TenantService
        Parameters:
        sid - identifier of the session (need to be administrator)
        tenantId - identifier of the tenant
        Throws:
        Exception - database error