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.unittree.service.action;
35  
36  import java.util.List;
37  import java.util.Locale;
38  
39  import fr.paris.lutece.plugins.unittree.business.action.IAction;
40  import fr.paris.lutece.portal.business.user.AdminUser;
41  import fr.paris.lutece.portal.service.rbac.RBACResource;
42  
43  /**
44   *
45   * IActionService
46   *
47   */
48  public interface IActionService
49  {
50      /**
51       * Get the list of actions by filter by permission
52       * 
53       * @param strActionType
54       *            the action type
55       * @param locale
56       *            the locale
57       * @param user
58       *            the current user
59       * @return a list of {@link IAction}
60       */
61      List<IAction> getListActions( String strActionType, Locale locale, AdminUser user );
62  
63      /**
64       * Get the list of actions by filter by permission
65       * 
66       * @param strActionType
67       *            the action type
68       * @param locale
69       *            the locale
70       * @param user
71       *            the current user
72       * @param strPermission
73       *            the permission
74       * @return a list of {@link IAction}
75       */
76      List<IAction> getListActions( String strActionType, Locale locale, AdminUser user, String strPermission );
77  
78      /**
79       * Get the list of actions by filter by permission
80       * 
81       * @param strActionType
82       *            the action type
83       * @param locale
84       *            the locale
85       * @param resource
86       *            the resource
87       * @param user
88       *            the current user
89       * @return a list of {@link IAction}
90       */
91      List<IAction> getListActions( String strActionType, Locale locale, RBACResource resource, AdminUser user );
92  
93      /**
94       * Get the list of actions by filter by permission
95       * 
96       * @param strActionType
97       *            the action type
98       * @param locale
99       *            the locale
100      * @param resource
101      *            the resource
102      * @param user
103      *            the current user
104      * @param strPermission
105      *            the permission
106      * @return a list of {@link IAction}
107      */
108     List<IAction> getListActions( String strActionType, Locale locale, RBACResource resource, AdminUser user, String strPermission );
109 }