fr.paris.lutece.plugins.greetingscard.business
Interface IGreetingsCardDAO

All Known Implementing Classes:
GreetingsCardDAO

public interface IGreetingsCardDAO

Interface for GreetingsCardDAO


Method Summary
 void delete(java.lang.String strIdGC, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Delete a record from the table
 void deleteList(java.lang.String strIdGC, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove a list of greetings card
 java.util.Collection<GreetingsCard> findAll(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Finds all objects of this type
 java.util.Collection<GreetingsCard> findByGreetingsCardTemplateId(int nIdGreetingsCardTemplate, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns the list of greetings cards of a greetings card template
 java.util.Collection<GreetingsCard> findByTemplateAndDate(int nIdGreetingsCardTemplate, java.util.Date dateMin, java.util.Date dateMax, int nResultsLimit, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get greetings card with a given template and sent between two given dates
 java.util.Collection<GreetingsCard> findCardsToSendNotification(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the collection of greetings cards that has been red and that has the notify sender flag set.
 java.util.List<java.lang.String> findDomainNameOfMailSent(GreetingsCardFilter greetingsCardFilter, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns the list of domain name of mail sent
 java.util.Map<java.lang.String,java.lang.Integer> findNumberOfMailReadByDomain(GreetingsCardFilter greetingsCardFilter, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Return the number of mail red for each domains
 java.util.Map<java.lang.String,java.lang.Integer> findNumberOfMailSentByDomain(GreetingsCardFilter greetingsCardFilter, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Return the number of mail sent for each domains
 int findNumberTotalOfMailSentWithoutCopy(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the total number of cards sent without archives.
 void insert(GreetingsCard greetingsCard, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Insert a new record in the table.
 GreetingsCard load(java.lang.String strIdGC, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          load the data of GreetingsCard from the table
 void store(GreetingsCard greetingsCard, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update the record in the table
 

Method Detail

insert

void insert(GreetingsCard greetingsCard,
            fr.paris.lutece.portal.service.plugin.Plugin plugin)
Insert a new record in the table.

Parameters:
greetingsCard - The Instance of the GreetingsCard object
plugin - The plugin

delete

void delete(java.lang.String strIdGC,
            fr.paris.lutece.portal.service.plugin.Plugin plugin)
Delete a record from the table

Parameters:
strIdGC - The indentifier of the object GreetingsCard
plugin - The plugin

deleteList

void deleteList(java.lang.String strIdGC,
                fr.paris.lutece.portal.service.plugin.Plugin plugin)
Remove a list of greetings card

Parameters:
strIdGC - The comma separated list of greetings cards ids
plugin - The plugin

load

GreetingsCard load(java.lang.String strIdGC,
                   fr.paris.lutece.portal.service.plugin.Plugin plugin)
load the data of GreetingsCard from the table

Parameters:
strIdGC - The identifier of the object GreetingsCard
plugin - The plugin
Returns:
The Instance of the object GreetingsCard

store

void store(GreetingsCard greetingsCard,
           fr.paris.lutece.portal.service.plugin.Plugin plugin)
Update the record in the table

Parameters:
greetingsCard - The instance of the GreetingsCard to update
plugin - The plugin

findAll

java.util.Collection<GreetingsCard> findAll(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Finds all objects of this type

Parameters:
plugin - The plugin
Returns:
A collection of objects

findByGreetingsCardTemplateId

java.util.Collection<GreetingsCard> findByGreetingsCardTemplateId(int nIdGreetingsCardTemplate,
                                                                  fr.paris.lutece.portal.service.plugin.Plugin plugin)
Returns the list of greetings cards of a greetings card template

Parameters:
nIdGreetingsCardTemplate - The greetings card template identifier
plugin - The plugin
Returns:
A Collection of greetings cards. Messages and messages 2 of greetings cards are not loaded.

findDomainNameOfMailSent

java.util.List<java.lang.String> findDomainNameOfMailSent(GreetingsCardFilter greetingsCardFilter,
                                                          fr.paris.lutece.portal.service.plugin.Plugin plugin)
Returns the list of domain name of mail sent

Parameters:
greetingsCardFilter - The greetings card filter
plugin - The plugin
Returns:
A list of domain

findNumberOfMailSentByDomain

java.util.Map<java.lang.String,java.lang.Integer> findNumberOfMailSentByDomain(GreetingsCardFilter greetingsCardFilter,
                                                                               fr.paris.lutece.portal.service.plugin.Plugin plugin)
Return the number of mail sent for each domains

Parameters:
greetingsCardFilter - The greetings card filter
plugin - The plugin
Returns:
A map containing associations of domain names and numbers of email sent. Only cards matching the filter are considered.

findNumberTotalOfMailSentWithoutCopy

int findNumberTotalOfMailSentWithoutCopy(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the total number of cards sent without archives. Copies are ignored

Parameters:
plugin - The plugin
Returns:
The number of cards sent without copies and archives.

findNumberOfMailReadByDomain

java.util.Map<java.lang.String,java.lang.Integer> findNumberOfMailReadByDomain(GreetingsCardFilter greetingsCardFilter,
                                                                               fr.paris.lutece.portal.service.plugin.Plugin plugin)
Return the number of mail red for each domains

Parameters:
greetingsCardFilter - The greetings card filter
plugin - The plugin
Returns:
A map containing associations of domain names and numbers of email red. Only cards matching the filter are considered.

findCardsToSendNotification

java.util.Collection<GreetingsCard> findCardsToSendNotification(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the collection of greetings cards that has been red and that has the notify sender flag set.

Parameters:
nStatus - Status
plugin - The plugin
Returns:
The collection of greetings cards that has been red and that has the notify sender flag set. The collection may be empty.

findByTemplateAndDate

java.util.Collection<GreetingsCard> findByTemplateAndDate(int nIdGreetingsCardTemplate,
                                                          java.util.Date dateMin,
                                                          java.util.Date dateMax,
                                                          int nResultsLimit,
                                                          fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get greetings card with a given template and sent between two given dates

Parameters:
nIdGreetingsCardTemplate - Id of the template of greetings cards
dateMin - Minimum sent date
dateMax - Maximum sent date
nResultsLimit - Maximum number of results returned. If the number is 0, then every object is considered
plugin - The plugin
Returns:
The collection of greetings cards. Messages and messages 2 of greetings cards are not loaded.


Copyright © 2012 Mairie de Paris. All Rights Reserved.