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.portal.business.user.menu;
35
36 import javax.servlet.http.HttpServletRequest;
37
38 /**
39 * Admin user menu item provider
40 *
41 * @since 6.2.0
42 */
43 public interface IAdminUserMenuItemProvider
44 {
45 /**
46 * Should this item be included for the request.
47 *
48 * @param request
49 * the request
50 * @return <code>true</code> if this item should be included, <code>false</code> otherwise
51 */
52 boolean isInvoked( HttpServletRequest request );
53
54 /**
55 * Get the admin user menu item
56 *
57 * @param request
58 * the request
59 * @return the admin user menu item
60 */
61 AdminUserMenuItem getItem( HttpServletRequest request );
62
63 /**
64 * Get the item name.
65 *
66 * The item name serves item ordering purposes.
67 *
68 * @return the item name
69 */
70 String getName( );
71
72 /**
73 * Sets the item name.
74 *
75 * The item name serves item ordering purposes.
76 *
77 * @param strName
78 */
79 void setName( String strName );
80 }