1 /* 2 * Copyright (c) 2002-2015, 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.adminwall.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 40 import java.util.Collection; 41 42 43 /** 44 * This class provides instances management methods (create, find, ...) for Hashtag objects 45 */ 46 public final class HashtagHome 47 { 48 // Static variable pointed at the DAO instance 49 private static IHashtagDAO _dao = SpringContextService.getBean( "adminwall.hashtagDAO" ); 50 private static Plugin _plugin = PluginService.getPlugin( "adminwall" ); 51 52 /** 53 * Private constructor - this class need not be instantiated 54 */ 55 private HashtagHome( ) 56 { 57 } 58 59 /** 60 * Create an instance of the hashtag class 61 * @param hashtag The instance of the Hashtag which contains the informations to store 62 * @return The instance of hashtag which has been created with its primary key. 63 */ 64 public static Hashtag create( Hashtag hashtag ) 65 { 66 _dao.insert( hashtag, _plugin ); 67 68 return hashtag; 69 } 70 71 /** 72 * Update of the hashtag which is specified in parameter 73 * @param hashtag The instance of the Hashtag which contains the data to store 74 * @return The instance of the hashtag which has been updated 75 */ 76 public static Hashtag update( Hashtag hashtag ) 77 { 78 _dao.store( hashtag, _plugin ); 79 80 return hashtag; 81 } 82 83 /** 84 * Remove the hashtag whose identifier is specified in parameter 85 * @param nHashtagId The hashtag Id 86 */ 87 public static void remove( int nHashtagId ) 88 { 89 _dao.delete( nHashtagId, _plugin ); 90 } 91 92 /////////////////////////////////////////////////////////////////////////// 93 // Finders 94 95 /** 96 * Returns an instance of a hashtag whose identifier is specified in parameter 97 * @param nKey The hashtag primary key 98 * @return an instance of Hashtag 99 */ 100 public static Hashtag findByPrimaryKey( int nKey ) 101 { 102 return _dao.load( nKey, _plugin ); 103 } 104 105 /** 106 * Load the data of all the hashtag objects and returns them in form of a collection 107 * @return the collection which contains the data of all the hashtag objects 108 */ 109 public static Collection<Hashtag> getHashtagsList( ) 110 { 111 return _dao.selectHashtagsList( _plugin ); 112 } 113 114 /** 115 * Returns an id whose content contains the Tag specified in parameter 116 * @param strTag The tag 117 * @return the hashtag Id 118 */ 119 public static int getId( String strTag ) 120 { 121 return _dao.selectId( strTag, _plugin ); 122 } 123 }