View Javadoc
1   /*
2    * Copyright (c) 2002-2022, 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.workflow.modules.comment.service;
35  
36  import fr.paris.lutece.plugins.workflow.modules.comment.business.CommentValue;
37  import fr.paris.lutece.plugins.workflow.modules.comment.business.TaskCommentConfig;
38  import fr.paris.lutece.plugins.workflow.utils.WorkflowUtils;
39  import fr.paris.lutece.plugins.workflowcore.service.config.ITaskConfigService;
40  import fr.paris.lutece.plugins.workflowcore.service.task.Task;
41  
42  import org.apache.commons.lang3.StringUtils;
43  
44  import java.util.HashMap;
45  import java.util.Locale;
46  import java.util.Map;
47  
48  import javax.inject.Inject;
49  import javax.inject.Named;
50  
51  import javax.servlet.http.HttpServletRequest;
52  
53  /**
54   *
55   * TaskComment
56   *
57   */
58  public class TaskComment extends Task
59  {
60      private static final String PARAMETER_COMMENT_VALUE = "comment_value";
61      private static final String BEAN_COMMENT_CONFIG_SERVICE = "workflow.taskCommentConfigService";
62      @Inject
63      @Named( BEAN_COMMENT_CONFIG_SERVICE )
64      private ITaskConfigService _taskCommentConfigService;
65      @Inject
66      private ICommentValueService _commentValueService;
67  
68      /**
69       * {@inheritDoc}
70       */
71      @Override
72      public void init( )
73      {
74          // Do nothing
75      }
76  
77      /**
78       * {@inheritDoc}
79       */
80      @Override
81      public void processTask( int nIdResourceHistory, HttpServletRequest request, Locale locale )
82      {
83          String strCommentValue = request.getParameter( PARAMETER_COMMENT_VALUE + "_" + this.getId( ) );
84          CommentValueflow/modules/comment/business/CommentValue.html#CommentValue">CommentValue commentValue = new CommentValue( );
85          commentValue.setIdResourceHistory( nIdResourceHistory );
86          commentValue.setIdTask( this.getId( ) );
87          commentValue.setValue( strCommentValue );
88          _commentValueService.create( commentValue, WorkflowUtils.getPlugin( ) );
89      }
90  
91      /**
92       * {@inheritDoc}
93       */
94      @Override
95      public void doRemoveConfig( )
96      {
97          _taskCommentConfigService.remove( this.getId( ) );
98          _commentValueService.removeByTask( this.getId( ), WorkflowUtils.getPlugin( ) );
99      }
100 
101     /**
102      * {@inheritDoc}
103      */
104     @Override
105     public void doRemoveTaskInformation( int nIdHistory )
106     {
107         _commentValueService.removeByHistory( nIdHistory, this.getId( ), WorkflowUtils.getPlugin( ) );
108     }
109 
110     /**
111      * {@inheritDoc}
112      */
113     @Override
114     public String getTitle( Locale locale )
115     {
116         TaskCommentConfig config = _taskCommentConfigService.findByPrimaryKey( this.getId( ) );
117 
118         if ( config != null )
119         {
120             return config.getTitle( );
121         }
122 
123         return StringUtils.EMPTY;
124     }
125 
126     /**
127      * {@inheritDoc}
128      */
129     @Override
130     public Map<String, String> getTaskFormEntries( Locale locale )
131     {
132         Map<String, String> mapEntriesForm = null;
133         TaskCommentConfig config = _taskCommentConfigService.findByPrimaryKey( this.getId( ) );
134 
135         if ( config != null )
136         {
137             mapEntriesForm = new HashMap<>( );
138             mapEntriesForm.put( PARAMETER_COMMENT_VALUE + "_" + this.getId( ), config.getTitle( ) );
139         }
140 
141         return mapEntriesForm;
142     }
143 }