Coverage Report

Coverage Report - fr.paris.lutece.plugins.releaser.business.ISiteDAO

Classes in this File

 /*
  * Copyright (c) 2002-2017, Mairie de Paris
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  *  1. Redistributions of source code must retain the above copyright notice
  *     and the following disclaimer.
  *
  *  2. Redistributions in binary form must reproduce the above copyright notice
  *     and the following disclaimer in the documentation and/or other materials
  *     provided with the distribution.
  *
  *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
  *     contributors may be used to endorse or promote products derived from
  *     this software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  *
  * License 1.0
  */
 
 package fr.paris.lutece.plugins.releaser.business;
 
 import fr.paris.lutece.portal.service.plugin.Plugin;
 import fr.paris.lutece.util.ReferenceList;
 import java.util.List;
 
 /**
  * ISiteDAO Interface
  */
 public interface ISiteDAO
 {
     /**
      * Insert a new record in the table.
      * 
      * @param site
      *            instance of the Site object to insert
      * @param plugin
      *            the Plugin
      */
     void insert( Site site, Plugin plugin );
 
     /**
      * Update the record in the table
      * 
      * @param site
      *            the reference of the Site
      * @param plugin
      *            the Plugin
      */
     void store( Site site, Plugin plugin );
 
     /**
      * Delete a record from the table
      * 
      * @param nKey
      *            The identifier of the Site to delete
      * @param plugin
      *            the Plugin
      */
     void delete( int nKey, Plugin plugin );
 
     // /////////////////////////////////////////////////////////////////////////
     // Finders
 
     /**
      * Load the data from the table
      * 
      * @param nKey
      *            The identifier of the site
      * @param plugin
      *            the Plugin
      * @return The instance of the site
      */
     Site load( int nKey, Plugin plugin );
 
     /**
      * Load the data of all the site objects and returns them as a list
      * 
      * @param plugin
      *            the Plugin
      * @return The list which contains the data of all the site objects
      */
     List<Site> selectSitesList( Plugin plugin );
 
     /**
      * Load the id of all the site objects and returns them as a list
      * 
      * @param plugin
      *            the Plugin
      * @return The list which contains the id of all the site objects
      */
     List<Integer> selectIdSitesList( Plugin plugin );
 
     /**
      * Load the data of all the site objects and returns them as a referenceList
      * 
      * @param plugin
      *            the Plugin
      * @return The referenceList which contains the data of all the site objects
      */
     ReferenceList selectSitesReferenceList( Plugin plugin );
 
     /**
      * Find all sites for a given cluster
      * 
      * @param nClusterId
      *            The cluster ID
      * @param plugin
      *            The plugin
      * @return the list which contains the data of all the site objects
      */
     List<Site> selectByCluster( int nClusterId, Plugin plugin );
 }

1		/*
2		* Copyright (c) 2002-2017, Mairie de Paris
3		* All rights reserved.
4		*
5		* Redistribution and use in source and binary forms, with or without
6		* modification, are permitted provided that the following conditions
7		* are met:
8		*
9		* 1. Redistributions of source code must retain the above copyright notice
10		* and the following disclaimer.
11		*
12		* 2. Redistributions in binary form must reproduce the above copyright notice
13		* and the following disclaimer in the documentation and/or other materials
14		* provided with the distribution.
15		*
16		* 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17		* contributors may be used to endorse or promote products derived from
18		* this software without specific prior written permission.
19		*
20		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21		* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23		* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24		* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25		* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26		* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27		* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28		* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29		* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30		* POSSIBILITY OF SUCH DAMAGE.
31		*
32		* License 1.0
33		*/
34
35		package fr.paris.lutece.plugins.releaser.business;
36
37		import fr.paris.lutece.portal.service.plugin.Plugin;
38		import fr.paris.lutece.util.ReferenceList;
39		import java.util.List;
40
41		/**
42		* ISiteDAO Interface
43		*/
44		public interface ISiteDAO
45		{
46		/**
47		* Insert a new record in the table.
48		*
49		* @param site
50		* instance of the Site object to insert
51		* @param plugin
52		* the Plugin
53		*/
54		void insert( Site site, Plugin plugin );
55
56		/**
57		* Update the record in the table
58		*
59		* @param site
60		* the reference of the Site
61		* @param plugin
62		* the Plugin
63		*/
64		void store( Site site, Plugin plugin );
65
66		/**
67		* Delete a record from the table
68		*
69		* @param nKey
70		* The identifier of the Site to delete
71		* @param plugin
72		* the Plugin
73		*/
74		void delete( int nKey, Plugin plugin );
75
76		// /////////////////////////////////////////////////////////////////////////
77		// Finders
78
79		/**
80		* Load the data from the table
81		*
82		* @param nKey
83		* The identifier of the site
84		* @param plugin
85		* the Plugin
86		* @return The instance of the site
87		*/
88		Site load( int nKey, Plugin plugin );
89
90		/**
91		* Load the data of all the site objects and returns them as a list
92		*
93		* @param plugin
94		* the Plugin
95		* @return The list which contains the data of all the site objects
96		*/
97		List<Site> selectSitesList( Plugin plugin );
98
99		/**
100		* Load the id of all the site objects and returns them as a list
101		*
102		* @param plugin
103		* the Plugin
104		* @return The list which contains the id of all the site objects
105		*/
106		List<Integer> selectIdSitesList( Plugin plugin );
107
108		/**
109		* Load the data of all the site objects and returns them as a referenceList
110		*
111		* @param plugin
112		* the Plugin
113		* @return The referenceList which contains the data of all the site objects
114		*/
115		ReferenceList selectSitesReferenceList( Plugin plugin );
116
117		/**
118		* Find all sites for a given cluster
119		*
120		* @param nClusterId
121		* The cluster ID
122		* @param plugin
123		* The plugin
124		* @return the list which contains the data of all the site objects
125		*/
126		List<Site> selectByCluster( int nClusterId, Plugin plugin );
127		}