View Javadoc
1   /*
2    * Copyright (c) 2002-2024, 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.identitystore.business.contract;
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  import java.util.Optional;
43  
44  /**
45   * This class provides instances management methods (create, find, ...) for AttributeRequirement objects
46   */
47  public final class AttributeRequirementHome
48  {
49      // Static variable pointed at the DAO instance
50      private static final IAttributeRequirementDAO _dao = SpringContextService.getBean( "identitystore.attributeRequirementDAO" );
51      private static final Plugin _plugin = PluginService.getPlugin( "identitystore" );
52  
53      /**
54       * Private constructor - this class need not be instantiated
55       */
56      private AttributeRequirementHome( )
57      {
58      }
59  
60      /**
61       * Create an instance of the attributeRequirement class
62       * 
63       * @param attributeRequirement
64       *            The instance of the AttributeRequirement which contains the informations to store
65       * @return The instance of attributeRequirement which has been created with its primary key.
66       */
67      public static AttributeRequirement../../../fr/paris/lutece/plugins/identitystore/business/contract/AttributeRequirement.html#AttributeRequirement">AttributeRequirement create( AttributeRequirement attributeRequirement, ServiceContract serviceContract )
68      {
69          _dao.insert( attributeRequirement, serviceContract.getId( ), _plugin );
70  
71          return attributeRequirement;
72      }
73  
74      /**
75       * Update of the attributeRequirement which is specified in parameter
76       * 
77       * @param attributeRequirement
78       *            The instance of the AttributeRequirement which contains the data to store
79       * @return The instance of the attributeRequirement which has been updated
80       */
81      public static AttributeRequirement../../../fr/paris/lutece/plugins/identitystore/business/contract/AttributeRequirement.html#AttributeRequirement">AttributeRequirement update( AttributeRequirement attributeRequirement )
82      {
83          _dao.store( attributeRequirement, _plugin );
84  
85          return attributeRequirement;
86      }
87  
88      /**
89       * Remove the attributeRequirement whose identifier is specified in parameter
90       * 
91       * @param nKey
92       *            The attributeRequirement Id
93       */
94      public static void remove( int nKey )
95      {
96          _dao.delete( nKey, _plugin );
97      }
98  
99      /**
100      * Returns an instance of a attributeRequirement whose identifier is specified in parameter
101      * 
102      * @param nKey
103      *            The attributeRequirement primary key
104      * @return an instance of AttributeRequirement
105      */
106     public static Optional<AttributeRequirement> findByPrimaryKey( int nKey )
107     {
108         return _dao.load( nKey, _plugin );
109     }
110 
111     /**
112      * Load the data of all the attributeRequirement objects and returns them as a list
113      * 
114      * @return the list which contains the data of all the attributeRequirement objects
115      */
116     public static List<AttributeRequirement> getAttributeRequirementsList( )
117     {
118         return _dao.selectAttributeRequirementsList( _plugin );
119     }
120 
121     /**
122      * Load the id of all the attributeRequirement objects and returns them as a list
123      * 
124      * @return the list which contains the id of all the attributeRequirement objects
125      */
126     public static List<Integer> getIdAttributeRequirementsList( )
127     {
128         return _dao.selectIdAttributeRequirementsList( _plugin );
129     }
130 
131     /**
132      * Load the data of all the attributeRequirement objects and returns them as a referenceList
133      * 
134      * @return the referenceList which contains the data of all the attributeRequirement objects
135      */
136     public static ReferenceList getAttributeRequirementsReferenceList( )
137     {
138         return _dao.selectAttributeRequirementsReferenceList( _plugin );
139     }
140 
141     /**
142      * Load the data of all the avant objects and returns them as a list
143      * 
144      * @param listIds
145      *            liste of ids
146      * @return the list which contains the data of all the avant objects
147      */
148     public static List<AttributeRequirement> getAttributeRequirementsListByIds( List<Integer> listIds )
149     {
150         return _dao.selectAttributeRequirementsListByIds( _plugin, listIds );
151     }
152 
153 }