Class GroovyTenantHelper


  • @Scriptable
    public final class GroovyTenantHelper
    extends Object
    • Constructor Detail

      • GroovyTenantHelper

        public GroovyTenantHelper​(ISession p_session)
    • Method Detail

      • getTenants

        public Set<String> getTenants()
                               throws Exception
        Get all available tenants.
        Parameters:
        p_session - The session.
        Returns:
        The available tenant values.
        Throws:
        Exception
      • getSelectedTenants

        public Set<String> getSelectedTenants()
                                       throws Exception
        Get a list of all selected tenants.
        Returns:
        The list of selected tenant values.
        Throws:
        Exception
      • getAllTenantValues

        public String getAllTenantValues()
                                  throws Exception
        Get the list of available tenant values as String with double pipe separator.
        Returns:
        The selected tenant values.
        Throws:
        Exception
      • getSelectedTenantValues

        public String getSelectedTenantValues()
                                       throws Exception
        Get the list of selected tenant values as String with double pipe separator.
        Returns:
        The selected tenant values.
        Throws:
        Exception
      • setSelectedTenant

        public void setSelectedTenant​(String p_strValue)
        Set the selected tenant value.
        Parameters:
        p_strValue - The value to select.
      • setSelectedTenants

        public void setSelectedTenants​(Set<String> p_values)
        Set the selected tenant values.
        Parameters:
        p_values - The values to select.
      • setSelectedTenants

        public void setSelectedTenants​(String p_strValues)
        Set the selected tenants. The tenant values must be separated by double pipe.
        Parameters:
        p_strValues - The The values to select as piped separated string. Example: "tenant1||tenant2"