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.business.action;
35  
36  import java.util.Locale;
37  
38  import fr.paris.lutece.portal.service.i18n.Localizable;
39  import fr.paris.lutece.portal.service.rbac.RBACAction;
40  
41  /**
42   *
43   * IAction
44   *
45   */
46  public interface IAction extends Localizable, RBACAction
47  {
48      /**
49       * Set the id action
50       * 
51       * @param nIdAction
52       *            the nIdAction to set
53       */
54      void setIdAction( int nIdAction );
55  
56      /**
57       * Get the id action
58       * 
59       * @return the nIdAction
60       */
61      int getIdAction( );
62  
63      /**
64       * Implements Localizable
65       * 
66       * @param locale
67       *            The current locale
68       */
69      void setLocale( Locale locale );
70  
71      /**
72       * Returns the Url
73       * 
74       * @return The Url
75       */
76      String getUrl( );
77  
78      /**
79       * Sets the Url
80       * 
81       * @param strUrl
82       *            The Url
83       */
84      void setUrl( String strUrl );
85  
86      /**
87       * Returns the NameKey
88       * 
89       * @return The NameKey
90       */
91      String getNameKey( );
92  
93      /**
94       * Returns the Name
95       * 
96       * @return The Name
97       */
98      String getName( );
99  
100     /**
101      * Sets the NameKey
102      * 
103      * @param strNameKey
104      *            The NameKey
105      */
106     void setNameKey( String strNameKey );
107 
108     /**
109      * Returns the DescriptionKey
110      * 
111      * @return The DescriptionKey
112      */
113     String getDescriptionKey( );
114 
115     /**
116      * Returns the Description
117      * 
118      * @return The Description
119      */
120     String getDescription( );
121 
122     /**
123      * Sets the DescriptionKey
124      * 
125      * @param strDescriptionKey
126      *            The DescriptionKey
127      */
128     void setDescriptionKey( String strDescriptionKey );
129 
130     /**
131      * Returns the IconUrl
132      * 
133      * @return The IconUrl
134      */
135     String getIcon( );
136 
137     /**
138      * Sets the IconUrl
139      * 
140      * @param strIconUrl
141      *            The IconUrl
142      */
143     void setIcon( String strIconUrl );
144 
145     /**
146      * Returns the permission associated to the action
147      * 
148      * @return The permission
149      */
150     String getPermission( );
151 
152     /**
153      * Sets the Permission
154      * 
155      * @param strPermission
156      *            The Permission
157      */
158     void setPermission( String strPermission );
159 
160     /**
161      * Get the action type
162      * 
163      * @return the action type
164      */
165     String getActionType( );
166 
167     /**
168      * Set the action type
169      * 
170      * @param strActionType
171      *            the action type
172      */
173     void setActionType( String strActionType );
174 }