Package ch.tocco.nice2.optional.newsletter.impl.actions

Class UserNewsletterConfiguration

java.lang.Object

ch.tocco.nice2.optional.newsletter.api.AbstractNewsletterConfiguration

ch.tocco.nice2.optional.newsletter.impl.actions.UserNewsletterConfiguration

All Implemented Interfaces:

NewsletterConfiguration

@Component
public class UserNewsletterConfiguration
extends AbstractNewsletterConfiguration

Field Summary

Fields inherited from class ch.tocco.nice2.optional.newsletter.api.AbstractNewsletterConfiguration

context, queryBuilderFactory

Constructor Summary

Constructors

Constructor	Description
UserNewsletterConfiguration(QueryBuilderFactory queryBuilderFactory, Context context)

Method Summary

Modifier and Type	Method	Description
boolean	allowCreationOfNewEntity()
String	getEntityName()
Entity	getExistingEntity(String identifier)	returns an entity based on a identifier
String	getInfoMailName()
void	handleAffectedNewsletterEntity(Entity entity)	is called after a newsletter recipient is created or updated
void	unsubscribe(String identifier)	unsubscribes a newsletter recipient based on a identifier

Methods inherited from class ch.tocco.nice2.optional.newsletter.api.AbstractNewsletterConfiguration

getEntityByUuidOrThrow, throwIfMailAlreadyExists

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserNewsletterConfiguration

public UserNewsletterConfiguration(QueryBuilderFactory queryBuilderFactory,
 Context context)

Method Details

getExistingEntity

public Entity getExistingEntity(String identifier)
                         throws PersistException

Description copied from interface: NewsletterConfiguration

returns an entity based on a identifier

Parameters:

identifier - identifier provided by user

Throws:

PersistException

handleAffectedNewsletterEntity

public void handleAffectedNewsletterEntity(Entity entity)
                                    throws PersistException

Description copied from interface: NewsletterConfiguration

is called after a newsletter recipient is created or updated

Parameters:

entity - the entity affected

Throws:

PersistException

getInfoMailName

public String getInfoMailName()

Returns:

the template id to be used in info mail

unsubscribe

public void unsubscribe(String identifier)
                 throws PersistException,
InterruptedException

Description copied from interface: NewsletterConfiguration

unsubscribes a newsletter recipient based on a identifier

Parameters:

identifier - identifier provided by user

Throws:

PersistException

InterruptedException

getEntityName

public String getEntityName()

Returns:

the name of the entity the configuration is used for

allowCreationOfNewEntity

public boolean allowCreationOfNewEntity()

Returns:

is it allowed to create new newsletter recipient with this entity