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