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.web.action;
35  
36  import java.util.List;
37  import java.util.Map;
38  
39  import javax.servlet.http.HttpServletRequest;
40  
41  import fr.paris.lutece.plugins.unittree.business.unit.Unit;
42  import fr.paris.lutece.portal.business.user.AdminUser;
43  import fr.paris.lutece.portal.service.admin.AccessDeniedException;
44  
45  /**
46   *
47   * IUnitPluginAction
48   *
49   */
50  public interface IUnitSearchFields
51  {
52      /**
53       * Get the items per page
54       * 
55       * @return the items per page
56       */
57      int getItemsPerPage( );
58  
59      /**
60       * Set the items per page
61       * 
62       * @param nItemsPerPage
63       *            the items per page
64       */
65      void setItemsPerPage( int nItemsPerPage );
66  
67      /**
68       * Default items per page
69       * 
70       * @return default items per page
71       */
72      int getDefaultItemsPerPage( );
73  
74      /**
75       * Default items per page
76       * 
77       * @param nDefaultItemsPerPage
78       *            default items per page
79       */
80      void setDefaultItemsPerPage( int nDefaultItemsPerPage );
81  
82      /**
83       * Current page index
84       * 
85       * @return current page index
86       */
87      String getCurrentPageIndex( );
88  
89      /**
90       * Current page index
91       * 
92       * @param strCurrentPageIndex
93       *            current page index
94       */
95      void setCurrentPageIndex( String strCurrentPageIndex );
96  
97      /**
98       * Set the sorted attribute name from the HTTP request
99       * 
100      * @param request
101      *            the HTTP request
102      */
103     void setSortedAttributeName( HttpServletRequest request );
104 
105     /**
106      * Get the sorted attribute name
107      * 
108      * @return the sorted attibute name
109      */
110     String getSortedAttributeName( );
111 
112     /**
113      * Set the asc sort from the HTTP request
114      * 
115      * @param request
116      *            the HTTP request
117      */
118     void setAscSort( HttpServletRequest request );
119 
120     /**
121      * Check if it is an asc sort
122      * 
123      * @return true if it is an asc sort, false otherwise
124      */
125     boolean isAscSort( );
126 
127     /**
128      * Fill the model for the user search form
129      * 
130      * @param listUsers
131      *            the list of users
132      * @param strBaseUrl
133      *            the base url
134      * @param request
135      *            the HTTP request
136      * @param model
137      *            the model
138      * @param unit
139      *            the unit
140      * @throws AccessDeniedException
141      *             exception if the user does not have the rights
142      */
143     void fillModelForUserSearchForm( List<AdminUser> listUsers, String strBaseUrl, HttpServletRequest request, Map<String, Object> model, Unit unit )
144             throws AccessDeniedException;
145 
146     /**
147      * Check if if it an in depth search. <br />
148      * It will check if the request possesses the parameter <strong>isInDepthSearch</strong>
149      * 
150      * @param request
151      *            the HTTP request
152      */
153     void setInDepthSearch( HttpServletRequest request );
154 
155     /**
156      * Check if it is an in depth search
157      * 
158      * @return true if it is an in depth search, false otherwise
159      */
160     boolean isInDepthSearch( );
161 }