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;
35
36 import fr.paris.lutece.portal.service.spring.SpringContextService;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.Collection;
40
41 /**
42 * This class provides instances management methods (create, find, ...) for DocumentType objects
43 */
44 public final class DocumentTypeHome
45 {
46 // Static variable pointed at the DAO instance
47 private static IDocumentTypeDAO _dao = SpringContextService.getBean( "document.documentTypeDAO" );
48
49 /**
50 * Private constructor - this class need not be instantiated
51 */
52 private DocumentTypeHome( )
53 {
54 }
55
56 /**
57 * Creation of an instance of documentType
58 *
59 * @param documentType
60 * The instance of the documentType which contains the informations to store
61 * @return The instance of documentType which has been created with its primary key.
62 */
63 public static DocumentType./../../../../fr/paris/lutece/plugins/document/business/DocumentType.html#DocumentType">DocumentType create( DocumentType documentType )
64 {
65 _dao.insert( documentType );
66
67 return documentType;
68 }
69
70 /**
71 * Update of the documentType which is specified in parameter
72 *
73 * @param documentType
74 * The instance of the documentType which contains the data to store
75 * @return The instance of the documentType which has been updated
76 */
77 public static DocumentType./../../../../fr/paris/lutece/plugins/document/business/DocumentType.html#DocumentType">DocumentType update( DocumentType documentType )
78 {
79 _dao.store( documentType );
80
81 return documentType;
82 }
83
84 /**
85 * Remove the DocumentType whose identifier is specified in parameter
86 *
87 * @param strCode
88 * The document type code
89 */
90 public static void remove( String strCode )
91 {
92 _dao.delete( strCode );
93 }
94
95 ///////////////////////////////////////////////////////////////////////////
96 // Finders
97
98 /**
99 * Returns an instance of a documentType whose identifier is specified in parameter
100 *
101 * @return An instance of documentType
102 * @param strCode
103 * The document type code
104 */
105 public static DocumentType findByPrimaryKey( String strCode )
106 {
107 return _dao.load( strCode );
108 }
109
110 /**
111 * Returns a collection of documentTypes objects
112 *
113 * @return A collection of documentTypes
114 */
115 public static Collection<DocumentType> findAll( )
116 {
117 return _dao.selectDocumentTypeList( );
118 }
119
120 /**
121 * Checks if type has documents
122 *
123 * @param strCode
124 * The document type code
125 * @return True if the given type has documents
126 */
127 public static boolean checkDocuments( String strCode )
128 {
129 return _dao.checkDocuments( strCode );
130 }
131
132 /**
133 * Reorder Attributes
134 *
135 * @param nIdAttribute1
136 * The id of the first attribute
137 * @param nOrderAttribute1
138 * The order of the first attribute
139 * @param nIdAttribute2
140 * The id of the second attribute
141 * @param nOrderAttribute2
142 * The order of the second attribute
143 */
144 public static void reorderAttributes( int nIdAttribute1, int nOrderAttribute1, int nIdAttribute2, int nOrderAttribute2 )
145 {
146 _dao.reorderAttributes( nIdAttribute1, nOrderAttribute1, nIdAttribute2, nOrderAttribute2 );
147 }
148
149 /**
150 * Get document types list
151 *
152 * @return document types list
153 */
154 public static ReferenceList getDocumentTypesList( )
155 {
156 return _dao.getDocumentTypeList( );
157 }
158
159 /**
160 * Sets the admin stylesheet
161 *
162 * @param baXslAdmin
163 * The stylesheet
164 * @param strCodeType
165 * The code type
166 */
167 public static void setAdminStyleSheet( byte [ ] baXslAdmin, String strCodeType )
168 {
169 _dao.setAdminStyleSheet( baXslAdmin, strCodeType );
170 }
171
172 /**
173 * Sets the content service stylesheet
174 *
175 * @param baXslContent
176 * The stylesheet
177 * @param strCodeType
178 * The code type
179 */
180 public static void setContentStyleSheet( byte [ ] baXslContent, String strCodeType )
181 {
182 _dao.setContentStyleSheet( baXslContent, strCodeType );
183 }
184 }