Package com.novomind.ecom.api.imail.routing.persistence

Interface TenantModifier

All Superinterfaces:
IntermediateStorageProvider, Modifier<Tenant>, UndeletableModifier<Tenant>
public interface TenantModifier extends UndeletableModifier<Tenant>, IntermediateStorageProvider
Defines an API to modify an instance of type Tenant
Since:
10.0.28

  • Method Details

    • getName

      String getName()
      Get the current tenant name which is held in this TenantModifier.
      Returns:
      the name as String
      Since:
      10.0.28

    • setName

      TenantModifier setName(String name) throws ValidationException

      Change the name of the associated Tenant.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      name - the new name as String
      Returns:
      the TenantModifier
      Throws:
      ValidationException - if the new name is invalid
      Since:
      10.0.28

    • validateName

      boolean validateName(String name) throws ValidationException
      Validate the given name.
      Parameters:
      name - the name to validate as String
      Returns:
      true if the name is valid
      Throws:
      ValidationException - if the name is invalid
      Since:
      10.0.28

    • getDescription

      String getDescription()
      Get the current tenant description which is held in this TenantModifier.
      Returns:
      the description as String
      Since:
      10.0.28

    • setDescription

      TenantModifier setDescription(String description) throws ValidationException

      Change the description of the associated Tenant.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      description - the new description as String
      Returns:
      the TenantModifier
      Throws:
      ValidationException - if the new description is invalid
      Since:
      10.0.28

    • validateDescription

      boolean validateDescription(String description) throws ValidationException
      Validate the given description.
      Parameters:
      description - the description to validate as String
      Returns:
      true if the description is valid
      Throws:
      ValidationException - if the description is invalid
      Since:
      10.0.28