fr.paris.lutece.plugins.newsletter.business

Class NewsLetterTemplateHome

java.lang.Object

fr.paris.lutece.plugins.newsletter.business.NewsLetterTemplateHome

public final class NewsLetterTemplateHome
extends Object

This class provides instances management methods (create, find, ...) for NewsLetterTemplate objects

Method Summary

Modifier and Type	Method and Description
static NewsLetterTemplate	create(NewsLetterTemplate newsletterTemplate, fr.paris.lutece.portal.service.plugin.Plugin plugin) Creation of an instance of a newsletter template
static NewsLetterTemplate	findByPrimaryKey(int nKey, fr.paris.lutece.portal.service.plugin.Plugin plugin) Returns an object NewsLetter's template from its identifier
static fr.paris.lutece.util.ReferenceList	getTemplateListByRef(fr.paris.lutece.portal.service.plugin.Plugin plugin) Fetches a template list
static List<NewsLetterTemplate>	getTemplatesCollectionByType(String strTopicType, fr.paris.lutece.portal.service.plugin.Plugin plugin) Returns a list of templates depending on the given topic type
static Collection<NewsLetterTemplate>	getTemplatesList(fr.paris.lutece.portal.service.plugin.Plugin plugin) Returns the list of every templates
static fr.paris.lutece.util.ReferenceList	getTemplatesListByType(String strTopicType, fr.paris.lutece.portal.service.plugin.Plugin plugin) Returns a list of templates depending on the given type
static Collection<NewsLetterTemplate>	getTemplatesListByWorkgoup(String strWorkgroupKey, fr.paris.lutece.portal.service.plugin.Plugin plugin) Returns the list of templates associated with a given workgroup
static void	remove(int nNewsLetterTemplateId, fr.paris.lutece.portal.service.plugin.Plugin plugin) Remove the record from the template identifier
static NewsLetterTemplate	update(NewsLetterTemplate newsletterTemplate, fr.paris.lutece.portal.service.plugin.Plugin plugin) Update of an instance of a newsletter template

Methods inherited from class java.lang.Object

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

Method Detail

getTemplatesList

public static Collection<NewsLetterTemplate> getTemplatesList(fr.paris.lutece.portal.service.plugin.Plugin plugin)

Returns the list of every templates

Parameters:

plugin - The Plugin

Returns:

a collection object

getTemplatesListByType

public static fr.paris.lutece.util.ReferenceList getTemplatesListByType(String strTopicType,
                                                                        fr.paris.lutece.portal.service.plugin.Plugin plugin)

Returns a list of templates depending on the given type

Parameters:

strTopicType - the topic type of templates to retrieve

plugin - The Plugin

Returns:

a Referencelist object

getTemplatesCollectionByType

public static List<NewsLetterTemplate> getTemplatesCollectionByType(String strTopicType,
                                                                    fr.paris.lutece.portal.service.plugin.Plugin plugin)

Returns a list of templates depending on the given topic type

Parameters:

strTopicType - the topic type of templates to retrieve

plugin - The Plugin

Returns:

a Collection object

create

public static NewsLetterTemplate create(NewsLetterTemplate newsletterTemplate,
                                        fr.paris.lutece.portal.service.plugin.Plugin plugin)

Creation of an instance of a newsletter template

Parameters:

newsletterTemplate - template An instance of a newsletter template which contains the informations to store

plugin - The Plugin

Returns:

The instance of a newsletter template which has been created with its primary key.

findByPrimaryKey

public static NewsLetterTemplate findByPrimaryKey(int nKey,
                                                  fr.paris.lutece.portal.service.plugin.Plugin plugin)

Returns an object NewsLetter's template from its identifier

Parameters:

nKey - the primary key of the newsletter's template

plugin - The Plugin

Returns:

an instance of the class

update

public static NewsLetterTemplate update(NewsLetterTemplate newsletterTemplate,
                                        fr.paris.lutece.portal.service.plugin.Plugin plugin)

Update of an instance of a newsletter template

Parameters:

newsletterTemplate - template An instance of a newsletter template which contains the informations to store

plugin - The Plugin

Returns:

The instance of a newsletter template which has been updated with its primary key.

remove

public static void remove(int nNewsLetterTemplateId,
                          fr.paris.lutece.portal.service.plugin.Plugin plugin)

Remove the record from the template identifier

Parameters:

nNewsLetterTemplateId - the template identifier

plugin - the Plugin

getTemplateListByRef

public static fr.paris.lutece.util.ReferenceList getTemplateListByRef(fr.paris.lutece.portal.service.plugin.Plugin plugin)

Fetches a template list

Parameters:

plugin - The plugin

Returns:

A reference list

getTemplatesListByWorkgoup

public static Collection<NewsLetterTemplate> getTemplatesListByWorkgoup(String strWorkgroupKey,
                                                                        fr.paris.lutece.portal.service.plugin.Plugin plugin)

Returns the list of templates associated with a given workgroup

Parameters:

strWorkgroupKey - The workgoup key

plugin - The Plugin

Returns:

a collection object