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.workflow;
35  
36  import fr.paris.lutece.util.ReferenceList;
37  import fr.paris.lutece.util.sql.DAOUtil;
38  
39  import java.util.Locale;
40  
41  
42  /**
43   * This class porvides Data Access methods for DocumentStateDAO  objects
44   */
45  public class DocumentStateDAO implements IDocumentStateDAO
46  {
47      // Constants    
48      private static final String SQL_QUERY_SELECT = " SELECT id_state, name_key, description_key FROM document_workflow_state WHERE id_state = ?  ";
49      private static final String SQL_QUERY_SELECTALL = "SELECT id_state , name_key , description_key FROM document_workflow_state ORDER BY state_order";
50  
51      /**
52       * Load the data of Rule from the table
53       *
54       * @param nDocumentStateId The document state id
55       * @return the instance of the Rule
56       */
57      public DocumentState load( int nDocumentStateId )
58      {
59          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT );
60          daoUtil.setInt( 1, nDocumentStateId );
61          daoUtil.executeQuery(  );
62  
63          DocumentState documentState = null;
64  
65          if ( daoUtil.next(  ) )
66          {
67              documentState = new DocumentState(  );
68              documentState.setId( daoUtil.getInt( 1 ) );
69              documentState.setNameKey( daoUtil.getString( 2 ) );
70              documentState.setDescriptionKey( daoUtil.getString( 3 ) );
71          }
72  
73          daoUtil.free(  );
74  
75          return documentState;
76      }
77  
78      /**
79       * Load the list of Document States
80       * @param locale The locale
81       * @return The Reference of the Document States
82       */
83      public ReferenceList selectDocumentStatesList( Locale locale )
84      {
85          ReferenceList list = new ReferenceList(  );
86          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL );
87          daoUtil.executeQuery(  );
88  
89          while ( daoUtil.next(  ) )
90          {
91              DocumentStateocument/business/workflow/DocumentState.html#DocumentState">DocumentState state = new DocumentState(  );
92              state.setLocale( locale );
93              state.setId( daoUtil.getInt( 1 ) );
94              state.setNameKey( daoUtil.getString( 2 ) );
95              list.addItem( state.getId(  ), state.getName(  ) );
96          }
97  
98          daoUtil.free(  );
99  
100         return list;
101     }
102 }