ITenant (pentaho-platform-api 9.3.0.0-424 API)

All Superinterfaces:

Serializable
```
public interface ITenant
extends Serializable
```
A tenant of the Pentaho platform. Contains name, path and ID of a tenant. This interface should be implemented if you need create your own tenant. Tenants are used for implementing the security mechanism.

Author:

rmansoor

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getId()`	The method is used for retrieving ID of the tenant.
`String`	`getName()`	This method gets the tenant's name.
`String`	`getRootFolderAbsolutePath()`	The method gets the absolute path to the tenant root folder.
`boolean`	`isEnabled()`	The method validates whether the tenant is enabled or not.

- Method Detail
  - getId
```
String getId()
```
    The method is used for retrieving ID of the tenant.
    
    Returns:
    
    Returns String representation of the tenant's ID.
  - getRootFolderAbsolutePath
```
String getRootFolderAbsolutePath()
```
    The method gets the absolute path to the tenant root folder. Folders for the data protected by current tenant (including the users' home folders) should be located under the tenant's root folder.
    
    Returns:
    
    Returns the absolute path to the tenant's root folder.
  - getName
```
String getName()
```
    This method gets the tenant's name.
    
    Returns:
    
    Returns the tenant's name.
  - isEnabled
```
boolean isEnabled()
```
    The method validates whether the tenant is enabled or not.
    
    Returns:
    
    Returns true if the tenant is enabled.