1 /* 2 * Copyright (c) 2002-2020, 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.spaces; 35 36 import fr.paris.lutece.util.ReferenceList; 37 38 import java.util.List; 39 import java.util.Locale; 40 41 42 /** 43 * DocumentSpaceDAO Interface 44 */ 45 public interface IDocumentSpaceDAO 46 { 47 /** 48 * Delete a record from the table 49 * @param nSpaceId The Id to delete 50 */ 51 void delete( int nSpaceId ); 52 53 /** 54 * Returns all allowed document types for a given space 55 * 56 * @param nSpaceId The space Id 57 * @return Allowed documents types as a ReferenceList 58 */ 59 ReferenceList getAllowedDocumentTypes( int nSpaceId ); 60 61 /** 62 * Load the list of documentSpaces 63 * 64 * @return The Collection of the DocumentSpaces 65 */ 66 ReferenceList getDocumentSpaceList( ); 67 68 /** 69 * Gets a list of icons available or space customization 70 * 71 * @return A list of icons 72 */ 73 ReferenceList getIconsList( ); 74 75 /** 76 * Load the list of documentSpaces 77 * @param locale The Locale 78 * @return The Collection of the DocumentSpaces 79 */ 80 ReferenceList getViewTypeList( Locale locale ); 81 82 /** 83 * Insert a new record in the table. 84 * @param space The space object 85 */ 86 void insert( DocumentSpace space ); 87 88 /** 89 * Load the data of DocumentSpace from the table 90 * @param nDocumentSpaceId The identifier of DocumentSpace 91 * @return the instance of the DocumentSpace 92 */ 93 DocumentSpace load( int nDocumentSpaceId ); 94 95 /** 96 * Select all spaces 97 * 98 * @return A collection of all spaces. 99 */ 100 List<DocumentSpace> selectAll( ); 101 102 /** 103 * Load the list of documentSpaces childs 104 * 105 * @param strCodeType the document type filter if needed (null if not) 106 * @param nSpaceId The space identifier 107 * @return The Collection of the DocumentSpaces 108 */ 109 List<DocumentSpace> selectChilds( int nSpaceId, String strCodeType ); 110 111 /** 112 * Load the list of documentSpaces authorizing the selected document type 113 * 114 * @param strCodeType the document type filter 115 * @param createDocumentIsAllowed code to define if document creation is allowed or not 116 * @return The Collection of the DocumentSpaces 117 */ 118 List<DocumentSpace> selectSpacesAllowingDocumentCreationByDocumentType( String strCodeType, 119 int createDocumentIsAllowed ); 120 121 /** 122 * Update the record in the table 123 * 124 * @param space The reference of space 125 */ 126 void store( DocumentSpace space ); 127 }