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