Package ch.tocco.nice2.userbase.api

Interface EmailTemplateLoadService

All Known Implementing Classes:
EmailTemplateLoadServiceImpl
public interface EmailTemplateLoadService
Loads email templates from Email_template entity.

  • Method Details

    • load

      EmailTemplate load(String uniqueId, String businessUnitUniqueId)
      Deprecated.
      Use getTemplate or load without a business
      Loads a email template for the specified business unit. Note: you probably need to load it in privileged mode to have read permission in another business unit.
      Parameters:
      uniqueId - unique id of template
      businessUnitUniqueId - unique id of business unit
      Returns:
      the email template

    • load

      EmailTemplate load(String uniqueId, Entity businessUnitEntity)
      Deprecated.
      Use getTemplate or load without a business
      Parameters:
      uniqueId - unique id of template
      businessUnitEntity - business unit entity
      Returns:
      the email template
      See Also:

    • load

      EmailTemplate load(Entity emailTemplateEntity)
      Loads a email template.
      Parameters:
      emailTemplateEntity - template entity
      Returns:
      the email template

    • getTemplate

      Optional<EmailTemplate> getTemplate(String uniqueId)
      Load email template with given uniqueId from the user's current BusinessUnit. ==== In case the current **user is in a business unit**, the template returned is selected as follows: 1. If in the current BusinessUnit a template with the correct uniqueId exists, it is returned. 2. Otherwise, If a template with the uniqueId and no BusinessUnit association exists, it is returned. 3. Otherwise, Optional.empty() is returned. In case the **user is not in a business unit** (e.g. he is in the {BusinessUnit.NULL_BUSINESS_UNIT}): 1. If a template with the uniqueId and no BusinessUnit exists, it is returned. 2. Otherwise, Optional.empty() is returned. Use #load if you prefer an exception is thrown if the email template is missing.
      Parameters:
      uniqueId - Unique id of the template
      Returns:
      The EmailTemplate

    • load

      EmailTemplate load(String uniqueId)
      Load email template with given uniqueId from the user's current BusinessUnit. ==== In case the current **user is in a business unit**, the template returned is selected as follows: 1. If in the current BusinessUnit a template with the correct uniqueId exists, it is returned. 2. Otherwise, If a template with the uniqueId and no BusinessUnit association exists, it is returned. 3. Otherwise, a RuntimeException is is thrown. In case the **user is not in a business unit** (e.g. he is in the {BusinessUnit.NULL_BUSINESS_UNIT}): 1. If a template with the uniqueId and no BusinessUnit exists, it is returned. 2. Otherwise, a RuntimeException is is thrown. Use #load if you prefer Optional.empty() is returned if the email template is missing.
      Parameters:
      uniqueId - Unique id of the template
      Returns:
      The EmailTemplate