View Javadoc
1   /*
2    * Copyright (c) 2002-2022, City of 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.resource.business.database;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  
38  import java.util.List;
39  
40  /**
41   * Interface of DAO of database resource type
42   */
43  public interface IDatabaseResourceTypeDAO
44  {
45      /**
46       * The name of the bean of the DAO
47       */
48      String BEAN_NAME = "resource.databaseResourceTypeDAO";
49  
50      /**
51       * insert a new resource type into the database
52       * 
53       * @param resourceType
54       *            The resource type to creates
55       * @param plugin
56       *            The plugin
57       */
58      void insert( DatabaseResourceType resourceType, Plugin plugin );
59  
60      /**
61       * Updates a resource type
62       * 
63       * @param resourceType
64       *            The resource
65       * @param plugin
66       *            The plugin
67       */
68      void update( DatabaseResourceType resourceType, Plugin plugin );
69  
70      /**
71       * Remove a resource type from the database
72       * 
73       * @param strResourceType
74       *            the name of the resource type
75       * @param plugin
76       *            the plugin
77       */
78      void delete( String strResourceType, Plugin plugin );
79  
80      /**
81       * Find a resource from its primary key
82       * 
83       * @param strResourceType
84       *            the id of the resource
85       * @param plugin
86       *            The plugin
87       * @return The resource type, or null if no resource type has the given primary key
88       */
89      DatabaseResourceType findByPrimaryKey( String strResourceType, Plugin plugin );
90  
91      /**
92       * Get the list of resource types
93       * 
94       * @param plugin
95       *            the plugin
96       * @return The list of resource types
97       */
98      List<DatabaseResourceType> findAll( Plugin plugin );
99  
100     /**
101      * Get the list of resource type names
102      * 
103      * @param plugin
104      *            the plugin
105      * @return the list of resource type names
106      */
107     List<String> getResourceTypesList( Plugin plugin );
108 }