1 /* 2 * Copyright (c) 2002-2023, 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.document.business.rules; 35 36 import fr.paris.lutece.portal.service.i18n.I18nService; 37 import fr.paris.lutece.portal.service.spring.SpringContextService; 38 import fr.paris.lutece.util.ReferenceList; 39 40 import java.util.Collection; 41 import java.util.List; 42 import java.util.Locale; 43 44 /** 45 * This class provides instances management methods (create, find, ...) for Rule objects 46 */ 47 public final class RuleHome 48 { 49 private static IRuleDAO _dao = SpringContextService.getBean( "document.ruleDAO" ); 50 private static IRuleTypesSet _ruleTypesSet = SpringContextService.getBean( "document.ruleTypesSet" ); 51 52 /** 53 * Private constructor - this class need not be instantiated 54 */ 55 private RuleHome( ) 56 { 57 } 58 59 /** 60 * Creation of an instance of rule 61 * 62 * @param rule 63 * The instance of the rule which contains the informations to store 64 * @return The instance of rule which has been created with its primary key. 65 */ 66 public static Ruleef="../../../../../../../fr/paris/lutece/plugins/document/business/rules/Rule.html#Rule">Rule create( Rule rule ) 67 { 68 _dao.insert( rule ); 69 70 return rule; 71 } 72 73 /** 74 * Update of the rule which is specified in parameter 75 * 76 * @param rule 77 * The instance of the rule which contains the data to store 78 * @return The instance of the rule which has been updated 79 */ 80 public static Ruleef="../../../../../../../fr/paris/lutece/plugins/document/business/rules/Rule.html#Rule">Rule update( Rule rule ) 81 { 82 _dao.store( rule ); 83 84 return rule; 85 } 86 87 /** 88 * Remove the Rule whose identifier is specified in parameter 89 * 90 * @param nRuleId 91 * The Rule Id 92 */ 93 public static void remove( int nRuleId ) 94 { 95 _dao.delete( nRuleId ); 96 } 97 98 /////////////////////////////////////////////////////////////////////////// 99 // Finders 100 101 /** 102 * Returns an instance of a rule whose identifier is specified in parameter 103 * 104 * @param nKey 105 * The Primary key of the rule 106 * @return An instance of rule 107 */ 108 public static Rule findByPrimaryKey( int nKey ) 109 { 110 return _dao.load( nKey, _ruleTypesSet ); 111 } 112 113 /** 114 * Returns a collection of rules objects 115 * 116 * @param locale 117 * the current local 118 * @return A collection of rules 119 */ 120 public static List<Rule> findAll( Locale locale ) 121 { 122 List<Rule> listRules = _dao.selectRuleList( _ruleTypesSet ); 123 124 return I18nService.localizeCollection( listRules, locale ); 125 } 126 127 /** 128 * Returns the rule types list 129 * 130 * @param locale 131 * the Locale 132 * @return The rule types list 133 */ 134 public static ReferenceList getRuleTypesList( Locale locale ) 135 { 136 return _ruleTypesSet.getRuleTypesList( locale ); 137 } 138 139 /** 140 * Create a new instance of a rule of a given type 141 * 142 * @param strRuleTypeId 143 * The key name of the rule type 144 * @return A new Rule instance 145 */ 146 public static Rule newInstance( String strRuleTypeId ) 147 { 148 return _ruleTypesSet.newInstance( strRuleTypeId ); 149 } 150 151 /** 152 * Returns all rule types 153 * 154 * @return A collection of rule types 155 */ 156 public static Collection<Rule> getRuleTypes( ) 157 { 158 return _ruleTypesSet.getRuleTypes( ); 159 } 160 161 /** 162 * Returns the rule type of a given class type 163 * 164 * @param rule 165 * The Rule object 166 * @return The rule type 167 */ 168 public static String getRuleTypeKey( Rule rule ) 169 { 170 return _ruleTypesSet.getRuleTypeKey( rule ); 171 } 172 173 /** 174 * Returns a collection of rules objects specified by rule type key 175 * 176 * @param strRuleTypeKey 177 * The rule type key 178 * @return A collection of Rule 179 */ 180 public static Collection<Rule> findByRuleTypeKey( String strRuleTypeKey ) 181 { 182 return _dao.selectRuleListByRuleTypeKey( strRuleTypeKey, _ruleTypesSet ); 183 } 184 }