View Javadoc
1   /*
2    * Copyright (c) 2002-2014, 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  package fr.paris.lutece.plugins.rss.business;
35  
36  import fr.paris.lutece.util.ReferenceList;
37  
38  import java.util.List;
39  
40  
41  /**
42   * IRssFeedDAO
43   */
44  public interface IRssFeedDAO
45  {
46      /**
47      * Generates a new primary key either in the active feed table or in the inactive feed one
48      * @param bActive <code>true</code> for the active feed table
49      * @return The new primary key
50      */
51      int newPrimaryKey( boolean bActive );
52  
53      /**
54       * Checks whether url referenced is pointed as an external feed
55       * @param strUrl The url to be tested
56       * @return The boolean result
57       */
58      boolean checkUrlNotUsed( String strUrl );
59  
60      /**
61       * Delete a record from the table
62       * @param rssFeed the feed to delete
63       */
64      void delete( RssFeed rssFeed );
65  
66      /**
67       * Insert a new record in the table.
68       * @param rssFeed The rssFeed object
69       */
70      void insert( RssFeed rssFeed );
71  
72      /**
73       * Load the data of RssFeed from the table
74       * @return the instance of the RssFeed
75       * @param nRssFeedId The identifier of RssFeed
76       * @param bActive <code>true</code> if the field is active
77       */
78      RssFeed load( int nRssFeedId, boolean bActive );
79  
80      /**
81       * Load the list of rssFeeds
82       * @param bActive <code>true</code> for active feeds
83       * @return A referenceList representing the RssFeeds
84       */
85      ReferenceList selectRssFeedReferenceList( boolean bActive );
86  
87      /**
88       * Load the list of rssFeeds
89       * @param bActive <code>true</code> if the field is active
90       * @return The List of the RssFeeds
91       */
92      List<RssFeed> selectRssFeeds( boolean bActive );
93  
94      /**
95       * Update the record in the table
96       * @param rssFeed The reference of rssFeed
97       */
98      void store( RssFeed rssFeed );
99  
100     /**
101      * Update the record in the table
102      * @param rssFeed The reference of rssFeed
103      */
104     void storeLastFetchInfos( RssFeed rssFeed );
105 }