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.workflow;
35
36 import fr.paris.lutece.plugins.document.business.Document;
37 import fr.paris.lutece.util.sql.DAOUtil;
38
39 import java.util.ArrayList;
40 import java.util.List;
41
42 /**
43 * This class porvides Data Access methods for DocumentActionDAO objects
44 */
45 public class DocumentActionDAO implements IDocumentActionDAO
46 {
47 private static final String SQL_QUERY_FIND_BY_PRIMARY_KEY = "SELECT a.id_action,a.name_key, a.description_key, a.action_url, a.icon_url, a.action_permission, a.id_finish_state "
48 + " FROM document_workflow_action a WHERE id_action=? ";
49 private static final String SQL_QUERY_SELECT_ACTIONS = "SELECT a.id_action,a.name_key, a.description_key, a.action_url, a.icon_url, a.action_permission"
50 + " FROM document_workflow_action a, document_workflow_transition b " + " WHERE a.id_action = b.id_action AND b.id_state = ? ";
51
52 /**
53 * Load the data of Document Action from the table
54 *
55 * @param nIdAction
56 * The identifier of the action
57 * @return the instance of action
58 */
59 public DocumentAction load( int nIdAction )
60 {
61 DocumentAction action = null;
62 try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_FIND_BY_PRIMARY_KEY ) )
63 {
64 daoUtil.setInt( 1, nIdAction );
65 daoUtil.executeQuery( );
66
67 DocumentState finishState = null;
68
69 if ( daoUtil.next( ) )
70 {
71 action = new DocumentAction( );
72 action.setIdAction( daoUtil.getInt( 1 ) );
73 action.setNameKey( daoUtil.getString( 2 ) );
74 action.setDescriptionKey( daoUtil.getString( 3 ) );
75 action.setUrl( daoUtil.getString( 4 ) );
76 action.setIconUrl( daoUtil.getString( 5 ) );
77 action.setPermission( daoUtil.getString( 6 ) );
78
79 if ( daoUtil.getObject( 7 ) != null )
80 {
81 finishState = new DocumentState( );
82 finishState.setId( daoUtil.getInt( 7 ) );
83 action.setFinishDocumentState( finishState );
84 }
85 }
86 }
87 return action;
88 }
89
90 /**
91 * Load the list of actions for a document
92 *
93 * @return The Collection of actions
94 * @param document
95 * The document to add available actions
96 */
97 public List<DocumentAction> selectActions( Document document )
98 {
99 List<DocumentAction> listActions = new ArrayList<>( );
100 DocumentAction action = null;
101 try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_ACTIONS ) )
102 {
103 daoUtil.setInt( 1, document.getStateId( ) );
104 daoUtil.executeQuery( );
105
106 while ( daoUtil.next( ) )
107 {
108 action = new DocumentAction( );
109 action.setIdAction( daoUtil.getInt( 1 ) );
110 action.setNameKey( daoUtil.getString( 2 ) );
111 action.setDescriptionKey( daoUtil.getString( 3 ) );
112 action.setUrl( daoUtil.getString( 4 ) );
113 action.setIconUrl( daoUtil.getString( 5 ) );
114 action.setPermission( daoUtil.getString( 6 ) );
115 listActions.add( action );
116 }
117 }
118 return listActions;
119 }
120 }