Package com.logicaldoc.enterprise.webservice.soap

Interface TenantService

All Known Implementing Classes:

SoapTenantClient, SoapTenantService

public interface TenantService

This web service allows the administrator to handle the tenants

Since:

7.1

Author:

Marco Meschieri - LogicalDOC

Method Summary

Modifier and Type	Method	Description
void	deleteTenant(String sid, long tenantId)	Deletes an existing tenant.
WSTenant	getTenant(String sid, String name)	Gets a specific tenant by it's name
WSTenant	getTenantById(String sid, long tenantId)	Gets a specific tenant by it's identifier
WSTenant[]	listTenants(String sid)	Gets all existing tenants.
long	storeTenant(String sid, WSTenant tenant)	Create/Update a tenant.

Method Detail

listTenants

WSTenant[] listTenants(String sid)
                throws Exception

Gets all existing tenants.

Parameters:

sid - identifier of the session

Returns:

The list of tenants

Throws:

Exception - database error

getTenant

WSTenant getTenant(String sid,
                   String name)
            throws Exception

Gets a specific tenant by it's name

Parameters:

sid - identifier of the session

name - The tenant's name

Returns:

A value object containing the tenant metadata.

Throws:

Exception - database error

getTenantById

WSTenant getTenantById(String sid,
                       long tenantId)
                throws Exception

Gets a specific tenant by it's identifier

Parameters:

sid - identifier of the session

tenantId - identifier of the tenant

Returns:

A value object containing the tenant metadata.

Throws:

Exception - database error

storeTenant

long storeTenant(String sid,
                 WSTenant tenant)
          throws Exception

Create/Update a tenant. You can completely customize the tenant through a value object.

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

void deleteTenant(String sid,
                  long tenantId)
           throws Exception

Deletes an existing tenant.

Parameters:

sid - identifier of the session (need to be administrator)

tenantId - identifier of the tenant

Throws:

Exception - database error