fr.paris.lutece.plugins.directory.modules.pdfproducer.business.producerconfig
Interface IConfigProducerDAO

All Known Implementing Classes:
ConfigProducerDAO

public interface IConfigProducerDAO

IConfigProducerDAO


Method Summary
 void addNewConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin, ConfigProducer configProducer, java.util.List<java.lang.Integer> listIdEntry)
          This method add a new config with different directory entry selected by AdminUser
 boolean checkEntry(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdEntry)
          This method check if an entry is used by a config
 void copyProducerConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdConfig, java.util.Locale locale)
          This method copy a config
 void createDefaultConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdDirectory, int nIdConfig)
          This method add default config
 void deleteByDirectory(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdDirectory)
          This method delete all config by id directory
 void deleteProducerConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdConfigProducer)
          This method delete a config by id
 ConfigProducer loadConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdConfig)
          This method load a config
 int loadDefaultConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdDirectory)
          This method loads a default config
 java.util.List<java.lang.Integer> loadListConfigEntry(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdConfig)
          This method load a list of id Entry by id config
 java.util.List<ConfigProducer> loadListProducerConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdDirectory, java.lang.String strConfigType)
          This method load a list of config by directory id and type
 void modifyProducerConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin, ConfigProducer configProducer, java.util.List<java.lang.Integer> listIdEntry)
          This method modify a config
 void updateDefaultConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin, int nIdDirectory, int nIdConfig)
          This method update default config
 

Method Detail

addNewConfig

void addNewConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                  ConfigProducer configProducer,
                  java.util.List<java.lang.Integer> listIdEntry)
This method add a new config with different directory entry selected by AdminUser

Parameters:
plugin - The plugin
configProducer - configuration
listIdEntry - The list of entry id that appear in configuration

loadConfig

ConfigProducer loadConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                          int nIdConfig)
This method load a config

Parameters:
plugin - plugin
nIdConfig - config id
Returns:
a ConfigProducer

loadListProducerConfig

java.util.List<ConfigProducer> loadListProducerConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                                      int nIdDirectory,
                                                      java.lang.String strConfigType)
This method load a list of config by directory id and type

Parameters:
plugin - The plugin
nIdDirectory - The id of directory
strConfigType - type of config
Returns:
The ProducerConfig list

loadListConfigEntry

java.util.List<java.lang.Integer> loadListConfigEntry(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                                      int nIdConfig)
This method load a list of id Entry by id config

Parameters:
plugin - The plugin
nIdConfig - The config id
Returns:
The id entry list

deleteProducerConfig

void deleteProducerConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                          int nIdConfigProducer)
This method delete a config by id

Parameters:
plugin - plugin
nIdConfigProducer - id config producer

modifyProducerConfig

void modifyProducerConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                          ConfigProducer configProducer,
                          java.util.List<java.lang.Integer> listIdEntry)
This method modify a config

Parameters:
plugin - plugin
configProducer - configuration
listIdEntry - list of id entry

copyProducerConfig

void copyProducerConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                        int nIdConfig,
                        java.util.Locale locale)
This method copy a config

Parameters:
plugin - plugin
nIdConfig - id configproduducer
locale - locale

deleteByDirectory

void deleteByDirectory(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                       int nIdDirectory)
This method delete all config by id directory

Parameters:
plugin - plugin
nIdDirectory - id of directory

checkEntry

boolean checkEntry(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                   int nIdEntry)
This method check if an entry is used by a config

Parameters:
plugin - plugin
nIdEntry - id of entry
Returns:
true an entry is used by a config otherwise false

loadDefaultConfig

int loadDefaultConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                      int nIdDirectory)
This method loads a default config

Parameters:
plugin - plugin
nIdDirectory - id directory
Returns:
id config

createDefaultConfig

void createDefaultConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                         int nIdDirectory,
                         int nIdConfig)
This method add default config

Parameters:
plugin - plugin
nIdDirectory - id directory
nIdConfig - id config

updateDefaultConfig

void updateDefaultConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                         int nIdDirectory,
                         int nIdConfig)
This method update default config

Parameters:
plugin - plugin
nIdDirectory - id directory
nIdConfig - id config


Copyright © 2011 Mairie de Paris. All Rights Reserved.