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.util.mvc.admin.annotations;
35
36 import java.lang.annotation.Documented;
37 import java.lang.annotation.ElementType;
38 import java.lang.annotation.Inherited;
39 import java.lang.annotation.Retention;
40 import java.lang.annotation.RetentionPolicy;
41 import java.lang.annotation.Target;
42
43 /**
44 * Controller annotation to define XPage default parameters
45 */
46 @Retention( RetentionPolicy.RUNTIME )
47 @Inherited
48 @Target( ElementType.TYPE )
49 @Documented
50 public @interface Controller
51 {
52 /**
53 * The XPage name as it is called in the URL
54 *
55 * @return the controller jsp
56 */
57 String controllerJsp( );
58
59 /**
60 * Path of the controller JSP
61 *
62 * @return the controller path
63 */
64 String controllerPath( );
65
66 /**
67 * The right associated to the JSP
68 *
69 * @return the right
70 */
71 String right( );
72
73 /**
74 * The default page title property
75 *
76 * @return the property for the page title
77 */
78 String pageTitleProperty( ) default "";
79
80 /**
81 * The default page title i18n key
82 *
83 * @return the i18n key for the page title
84 */
85 String pageTitleI18nKey( ) default "";
86
87 /**
88 * The default page path property
89 *
90 * @return the i18n key for the page path
91 */
92 String pagePathI18nKey( ) default "";
93 }