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.plugins.document.business.Document;
37  import fr.paris.lutece.portal.service.i18n.I18nService;
38  import fr.paris.lutece.portal.service.spring.SpringContextService;
39  
40  import java.util.List;
41  import java.util.Locale;
42  
43  
44  /**
45   * This class provides instances management methods (create, find, ...) for DocumentAction objects
46   */
47  public final class DocumentActionHome
48  {
49      // Static variable pointed at the DAO instance
50      private static IDocumentActionDAO _dao = SpringContextService.getBean( "document.documentActionDAO" );
51  
52      /**
53       * Private constructor - this class need not be instantiated
54       */
55      private DocumentActionHome(  )
56      {
57      }
58  
59      /**
60       * Load the  Document Action
61       * @param nIdAction The identifier of the action
62       * @return the instance of action
63       */
64      public static DocumentAction findByPrimaryKey( int nIdAction )
65      {
66          return _dao.load( nIdAction );
67      }
68  
69      /**
70       * Returns the list of allowed actions for the current document
71       * @param document The document
72       * @param locale The locale
73       * @return A list of actions for the current document
74       */
75      public static List<DocumentAction> getActionsList( Document document, Locale locale )
76      {
77          List<DocumentAction> listActions = _dao.selectActions( document );
78  
79          return I18nService.localizeCollection( listActions, locale );
80      }
81  }