| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| SiteHome |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright (c) 2002-2017, 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.releaser.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 Site objects | |
| 45 | */ | |
| 46 | public final class SiteHome | |
| 47 | { | |
| 48 | // Static variable pointed at the DAO instance | |
| 49 | 1 | private static ISiteDAO _dao = SpringContextService.getBean( "releaser.siteDAO" ); |
| 50 | 1 | private static Plugin _plugin = PluginService.getPlugin( "releaser" ); |
| 51 | ||
| 52 | /** | |
| 53 | * Private constructor - this class need not be instantiated | |
| 54 | */ | |
| 55 | private SiteHome( ) | |
| 56 | 0 | { |
| 57 | 0 | } |
| 58 | ||
| 59 | /** | |
| 60 | * Create an instance of the site class | |
| 61 | * | |
| 62 | * @param site | |
| 63 | * The instance of the Site which contains the informations to store | |
| 64 | * @return The instance of site which has been created with its primary key. | |
| 65 | */ | |
| 66 | public static Site create( Site site ) | |
| 67 | { | |
| 68 | 1 | _dao.insert( site, _plugin ); |
| 69 | ||
| 70 | 1 | return site; |
| 71 | } | |
| 72 | ||
| 73 | /** | |
| 74 | * Update of the site which is specified in parameter | |
| 75 | * | |
| 76 | * @param site | |
| 77 | * The instance of the Site which contains the data to store | |
| 78 | * @return The instance of the site which has been updated | |
| 79 | */ | |
| 80 | public static Site update( Site site ) | |
| 81 | { | |
| 82 | 1 | _dao.store( site, _plugin ); |
| 83 | ||
| 84 | 1 | return site; |
| 85 | } | |
| 86 | ||
| 87 | /** | |
| 88 | * Remove the site whose identifier is specified in parameter | |
| 89 | * | |
| 90 | * @param nKey | |
| 91 | * The site Id | |
| 92 | */ | |
| 93 | public static void remove( int nKey ) | |
| 94 | { | |
| 95 | 1 | _dao.delete( nKey, _plugin ); |
| 96 | 1 | } |
| 97 | ||
| 98 | /** | |
| 99 | * Returns an instance of a site whose identifier is specified in parameter | |
| 100 | * | |
| 101 | * @param nKey | |
| 102 | * The site primary key | |
| 103 | * @return an instance of Site | |
| 104 | */ | |
| 105 | public static Site findByPrimaryKey( int nKey ) | |
| 106 | { | |
| 107 | 3 | return _dao.load( nKey, _plugin ); |
| 108 | } | |
| 109 | ||
| 110 | /** | |
| 111 | * Load the data of all the site objects and returns them as a list | |
| 112 | * | |
| 113 | * @return the list which contains the data of all the site objects | |
| 114 | */ | |
| 115 | public static List<Site> getSitesList( ) | |
| 116 | { | |
| 117 | 1 | return _dao.selectSitesList( _plugin ); |
| 118 | } | |
| 119 | ||
| 120 | /** | |
| 121 | * Load the id of all the site objects and returns them as a list | |
| 122 | * | |
| 123 | * @return the list which contains the id of all the site objects | |
| 124 | */ | |
| 125 | public static List<Integer> getIdSitesList( ) | |
| 126 | { | |
| 127 | 0 | return _dao.selectIdSitesList( _plugin ); |
| 128 | } | |
| 129 | ||
| 130 | /** | |
| 131 | * Load the data of all the site objects and returns them as a referenceList | |
| 132 | * | |
| 133 | * @return the referenceList which contains the data of all the site objects | |
| 134 | */ | |
| 135 | public static ReferenceList getSitesReferenceList( ) | |
| 136 | { | |
| 137 | 0 | return _dao.selectSitesReferenceList( _plugin ); |
| 138 | } | |
| 139 | ||
| 140 | /** | |
| 141 | * Find all sites for a given cluster | |
| 142 | * | |
| 143 | * @param nClusterId | |
| 144 | * The cluster ID | |
| 145 | * @return the list which contains the data of all the site objects | |
| 146 | */ | |
| 147 | public static List<Site> findByCluster( int nClusterId ) | |
| 148 | { | |
| 149 | 5 | return _dao.selectByCluster( nClusterId, _plugin ); |
| 150 | } | |
| 151 | ||
| 152 | } |