Package ch.tocco.nice2.optional.newsletter.api

Interface NewsletterConfiguration

All Known Implementing Classes:
AbstractNewsletterConfiguration, UserNewsletterConfiguration
public interface NewsletterConfiguration

  • Method Details

    • getExistingEntity

      Entity getExistingEntity(String identifier) throws PersistException
      returns an entity based on a identifier
      Parameters:
      identifier - identifier provided by user
      Throws:
      PersistException

    • handleAffectedNewsletterEntity

      void handleAffectedNewsletterEntity(Entity entity) throws PersistException, InterruptedException
      is called after a newsletter recipient is created or updated
      Parameters:
      entity - the entity affected
      Throws:
      PersistException
      InterruptedException

    • getEntityName

      String getEntityName()
      Returns:
      the name of the entity the configuration is used for

    • getInfoMailName

      String getInfoMailName()
      Returns:
      the template id to be used in info mail

    • unsubscribe

      void unsubscribe(String identifier) throws PersistException, InterruptedException
      unsubscribes a newsletter recipient based on a identifier
      Parameters:
      identifier - identifier provided by user
      Throws:
      PersistException
      InterruptedException

    • allowCreationOfNewEntity

      boolean allowCreationOfNewEntity()
      Returns:
      is it allowed to create new newsletter recipient with this entity