View Javadoc
1   /*
2    * Copyright (c) 2002-2018, 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.managewferror.business;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  import fr.paris.lutece.portal.service.plugin.PluginService;
38  import fr.paris.lutece.portal.service.spring.SpringContextService;
39  import fr.paris.lutece.util.ReferenceList;
40  
41  import java.util.List;
42  
43  /**
44   * This class provides instances management methods (create, find, ...) for Resource objects
45   */
46  public final class ResourceHome
47  {
48      // Static variable pointed at the DAO instance
49      private static IResourceDAO _dao = SpringContextService.getBean( "managewferror.resourceDAO" );
50      private static Plugin _plugin = PluginService.getPlugin( "managewferror" );
51  
52      /**
53       * Private constructor - this class need not be instantiated
54       */
55      private ResourceHome( )
56      {
57      }
58  
59      /**
60       * Create an instance of the resource class
61       * 
62       * @param resource
63       *            The instance of the resource which contains the informations to store
64       * @return The instance of resource which has been created with its primary key.
65       */
66      public static Resource create( Resource resource )
67      {
68          _dao.insert( resource, _plugin );
69  
70          return resource;
71      }
72  
73      /**
74       * Update of the resource which is specified in parameter
75       * 
76       * @param resource
77       *            The instance of the resource which contains the data to store
78       * @return The instance of the resource which has been updated
79       */
80      public static Resource update( Resource resource )
81      {
82          _dao.store( resource, _plugin );
83  
84          return resource;
85      }
86  
87      /**
88       * Remove the resource whose identifier is specified in parameter
89       * 
90       * @param nKey
91       *            The resource Id
92       */
93      public static void remove( int nKey )
94      {
95          _dao.delete( nKey, _plugin );
96      }
97  
98      /**
99       * Returns an instance of a resource whose identifier is specified in parameter
100      * 
101      * @param nKey
102      *            The resource primary key
103      * @return an instance of resource
104      */
105     public static Resource findByPrimaryKey( int nKey )
106     {
107         return _dao.load( nKey, _plugin );
108     }
109 
110     /**
111      * Returns an instance of a resource whose identifier is specified in parameter
112      * 
113      * @param nKey
114      *            The resource primary key
115      * @return an instance of resource
116      */
117     public static Resource findByIdResource( int nIdResource )
118     {
119         return _dao.loadByIdResource( nIdResource, _plugin );
120     }
121 
122     /**
123      * Load the data of all the Resource objects and returns them as a list
124      * 
125      * @return the list which contains the data of all the Resource objects
126      */
127     public static List<Resource> getResourcesList( )
128     {
129         return _dao.selectResourcesList( _plugin );
130     }
131 
132     /**
133      * Load the id of all the Resource objects and returns them as a list
134      * 
135      * @return the list which contains the id of all the Resource objects
136      */
137     public static List<Integer> getIdResourcesList( )
138     {
139         return _dao.selectIdResourcesList( _plugin );
140     }
141 
142     /**
143      * Load the data of all the Resource objects and returns them as a referenceList
144      * 
145      * @return the referenceList which contains the data of all the Resource objects
146      */
147     public static ReferenceList getResourcesReferenceList( )
148     {
149         return _dao.selectResourcesReferenceList( _plugin );
150     }
151 
152     /**
153      * Load the data of all the Resource objects and returns them as a list
154      * 
155      * @return the list which contains the data of all the Resource objects
156      */
157     public static List<Resource> getResourcesListByFilter( ResourceFilter filter )
158     {
159         return _dao.selectResourceListByFilter( filter, _plugin );
160     }
161 }