fr.paris.lutece.plugins.newsletter.business

Interface INewsLetterDAO

All Known Implementing Classes:

NewsLetterDAO

public interface INewsLetterDAO

The interface representing the business methods data layer must implement

Method Summary

Modifier and Type	Method and Description
boolean	checkLinkedPortlet(int nIdNewsletter) Checks whether a portlet uses the newsletter
boolean	checkPrimaryKey(int nKey, fr.paris.lutece.portal.service.plugin.Plugin plugin) Check the unicity of the primary key
void	delete(int nNewsLetterId, fr.paris.lutece.portal.service.plugin.Plugin plugin) Remove a record from the table
void	deleteOldUnconfirmed(Timestamp confirmLimitDate, fr.paris.lutece.portal.service.plugin.Plugin plugin) Performs confirm unsubscription process
void	deleteSubscriber(int nNewsLetterId, int nSubscriberId, fr.paris.lutece.portal.service.plugin.Plugin plugin) Remove the subscriber's inscription to a newsletter
void	insert(NewsLetter newsLetter, fr.paris.lutece.portal.service.plugin.Plugin plugin) Insert a new record in the table.
void	insertSubscriber(int nNewsLetterId, int nSubscriberId, boolean bValidate, Timestamp tToday, fr.paris.lutece.portal.service.plugin.Plugin plugin) Insert a new subscriber for a newsletter
void	insertSubscriber(int nNewsLetterId, int nSubscriberId, Timestamp tToday, fr.paris.lutece.portal.service.plugin.Plugin plugin) Insert a new subscriber for a newsletter
boolean	isRegistered(int nNewsLetterId, int nSubscriberId, fr.paris.lutece.portal.service.plugin.Plugin plugin) check if the subscriber is not yet registered to a newsletter
boolean	isTemplateUsed(int nTemplateId, fr.paris.lutece.portal.service.plugin.Plugin plugin) controls that a template is used by a newsletter
NewsLetter	load(int nNewsLetterId, fr.paris.lutece.portal.service.plugin.Plugin plugin) loads the data of the newsletter from the table
int	newPrimaryKey(fr.paris.lutece.portal.service.plugin.Plugin plugin) Generate a new primary key to add a newsletter
Collection<NewsLetter>	selectAll(fr.paris.lutece.portal.service.plugin.Plugin plugin) Select the list of the newsletters available
Collection<NewsLetter>	selectAllByTemplateId(int nTemplateId, fr.paris.lutece.portal.service.plugin.Plugin plugin) Gets a collection of NewsLetter associated with a given template
fr.paris.lutece.util.ReferenceList	selectAllId(fr.paris.lutece.portal.service.plugin.Plugin plugin) Select the list of the newsletters available
int	selectNbrActiveSubscribers(int nNewsLetterId, String strSearchString, fr.paris.lutece.portal.service.plugin.Plugin plugin) Counts the active subscribers for a newsletter
int	selectNbrSubscribers(int nNewsLetterId, String strSearchString, fr.paris.lutece.portal.service.plugin.Plugin plugin) Counts the subscribers for a newsletter
void	store(NewsLetter newsLetter, fr.paris.lutece.portal.service.plugin.Plugin plugin) Update the record in the table
void	validateSubscriber(int nNewsLetterId, int nSubscriberId, fr.paris.lutece.portal.service.plugin.Plugin plugin) Updates a subscriber for a newsletter

Method Detail

insert

void insert(NewsLetter newsLetter,
            fr.paris.lutece.portal.service.plugin.Plugin plugin)

Insert a new record in the table.

Parameters:

newsLetter - the object to insert

plugin - the Plugin

delete

void delete(int nNewsLetterId,
            fr.paris.lutece.portal.service.plugin.Plugin plugin)

Remove a record from the table

Parameters:

nNewsLetterId - the newsletter identifier

plugin - the Plugin

load

NewsLetter load(int nNewsLetterId,
                fr.paris.lutece.portal.service.plugin.Plugin plugin)

loads the data of the newsletter from the table

Parameters:

nNewsLetterId - the newsletter identifier

plugin - the Plugin

Returns:

the object inserted

store

void store(NewsLetter newsLetter,
           fr.paris.lutece.portal.service.plugin.Plugin plugin)

Update the record in the table

Parameters:

newsLetter - the object to be updated

plugin - the Plugin

checkPrimaryKey

boolean checkPrimaryKey(int nKey,
                        fr.paris.lutece.portal.service.plugin.Plugin plugin)

Check the unicity of the primary key

Parameters:

nKey - the key to be checked

plugin - the Plugin

Returns:

true if the identifier exist and false if not

checkLinkedPortlet

boolean checkLinkedPortlet(int nIdNewsletter)

Checks whether a portlet uses the newsletter

Parameters:

nIdNewsletter - the id of the newsletter

Returns:

true if the newsletter is used

newPrimaryKey

int newPrimaryKey(fr.paris.lutece.portal.service.plugin.Plugin plugin)

Generate a new primary key to add a newsletter

Parameters:

plugin - the Plugin

Returns:

the new key

selectAll

Collection<NewsLetter> selectAll(fr.paris.lutece.portal.service.plugin.Plugin plugin)

Select the list of the newsletters available

Parameters:

plugin - the Plugin

Returns:

a collection of objects

selectAllId

fr.paris.lutece.util.ReferenceList selectAllId(fr.paris.lutece.portal.service.plugin.Plugin plugin)

Select the list of the newsletters available

Parameters:

plugin - the Plugin

Returns:

a ReferenceList of id and name

selectAllByTemplateId

Collection<NewsLetter> selectAllByTemplateId(int nTemplateId,
                                             fr.paris.lutece.portal.service.plugin.Plugin plugin)

Gets a collection of NewsLetter associated with a given template

Parameters:

nTemplateId - The id of the template

plugin - the Plugin

Returns:

the collection of objects

insertSubscriber

void insertSubscriber(int nNewsLetterId,
                      int nSubscriberId,
                      Timestamp tToday,
                      fr.paris.lutece.portal.service.plugin.Plugin plugin)

Insert a new subscriber for a newsletter

Parameters:

nNewsLetterId - the newsletter identifier

nSubscriberId - the subscriber identifier

tToday - The day

plugin - the Plugin

deleteOldUnconfirmed

void deleteOldUnconfirmed(Timestamp confirmLimitDate,
                          fr.paris.lutece.portal.service.plugin.Plugin plugin)

Performs confirm unsubscription process

Parameters:

confirmLimitDate - all unconfirmed subscriber which subscription date is below confirmLimitDate will be deleted

plugin - the plugin

insertSubscriber

void insertSubscriber(int nNewsLetterId,
                      int nSubscriberId,
                      boolean bValidate,
                      Timestamp tToday,
                      fr.paris.lutece.portal.service.plugin.Plugin plugin)

Insert a new subscriber for a newsletter

Parameters:

nNewsLetterId - the newsletter identifier

nSubscriberId - the subscriber identifier

bValidate - the validation status

tToday - The day

plugin - the Plugin

validateSubscriber

void validateSubscriber(int nNewsLetterId,
                        int nSubscriberId,
                        fr.paris.lutece.portal.service.plugin.Plugin plugin)

Updates a subscriber for a newsletter

Parameters:

nNewsLetterId - the newsletter identifier

nSubscriberId - the subscriber identifier

plugin - the Plugin

deleteSubscriber

void deleteSubscriber(int nNewsLetterId,
                      int nSubscriberId,
                      fr.paris.lutece.portal.service.plugin.Plugin plugin)

Remove the subscriber's inscription to a newsletter

Parameters:

nNewsLetterId - the newsletter identifier

nSubscriberId - the subscriber identifier

plugin - the Plugin

isRegistered

boolean isRegistered(int nNewsLetterId,
                     int nSubscriberId,
                     fr.paris.lutece.portal.service.plugin.Plugin plugin)

check if the subscriber is not yet registered to a newsletter

Parameters:

nNewsLetterId - the newsletter identifier

nSubscriberId - the subscriber identifier

plugin - the Plugin

Returns:

true if he is registered and false if not

isTemplateUsed

boolean isTemplateUsed(int nTemplateId,
                       fr.paris.lutece.portal.service.plugin.Plugin plugin)

controls that a template is used by a newsletter

Parameters:

nTemplateId - the template identifier

plugin - the Plugin

Returns:

true if the template is used, false if not

selectNbrSubscribers

int selectNbrSubscribers(int nNewsLetterId,
                         String strSearchString,
                         fr.paris.lutece.portal.service.plugin.Plugin plugin)

Counts the subscribers for a newsletter

Parameters:

nNewsLetterId - the newsletter newsletter

strSearchString - the string to search in the subscriber's email

plugin - the Plugin

Returns:

the number of subscribers

selectNbrActiveSubscribers

int selectNbrActiveSubscribers(int nNewsLetterId,
                               String strSearchString,
                               fr.paris.lutece.portal.service.plugin.Plugin plugin)

Counts the active subscribers for a newsletter

Parameters:

nNewsLetterId - the newsletter newsletter

strSearchString - the string to search in the subscriber's email

plugin - the Plugin

Returns:

the number of subscribers