View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.crm.modules.mylutece.web;
35  
36  import fr.paris.lutece.portal.service.admin.AccessDeniedException;
37  
38  import java.util.Map;
39  
40  import javax.servlet.http.HttpServletRequest;
41  
42  
43  /**
44   *
45   * IResourceExtenderSearchFields
46   *
47   */
48  public interface ICRMMyLuteceSearchFields
49  {
50      /**
51      * Get the items per page
52      * @return the items per page
53      */
54      int getItemsPerPage(  );
55  
56      /**
57       * Set the items per page
58       * @param nItemsPerPage the items per page
59       */
60      void setItemsPerPage( int nItemsPerPage );
61  
62      /**
63      * Default items per page
64      * @return default items per page
65      */
66      int getDefaultItemsPerPage(  );
67  
68      /**
69       * Default items per page
70       * @param nDefaultItemsPerPage default items per page
71       */
72      void setDefaultItemsPerPage( int nDefaultItemsPerPage );
73  
74      /**
75       * Current page index
76       * @return current page index
77       */
78      String getCurrentPageIndex(  );
79  
80      /**
81       * Current page index
82       * @param strCurrentPageIndex current page index
83       */
84      void setCurrentPageIndex( String strCurrentPageIndex );
85  
86      /**
87       * Fill model.
88       *
89       * @param strBaseUrl the str base url
90       * @param request the request
91       * @param model the model
92       * @throws AccessDeniedException the access denied exception
93       */
94      void fillModel( String strBaseUrl, HttpServletRequest request, Map<String, Object> model )
95          throws AccessDeniedException;
96  
97      /**
98       * Inits the filter.
99       *
100      * @param request the request
101      */
102     void initFilter( HttpServletRequest request );
103 }