View Javadoc
1   /*
2    * Copyright (c) 2002-2025, 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.forms.web.entrytype;
35  
36  /**
37   * This class represents a type of display
38   *
39   */
40  public final class DisplayType
41  {
42      public static final DisplayTypetrytype/DisplayType.html#DisplayType">DisplayType EDITION_BACKOFFICE = new DisplayType( Mode.EDITION, false );
43      public static final DisplayTypentrytype/DisplayType.html#DisplayType">DisplayType SUBMIT_BACKOFFICE = new DisplayType( Mode.EDITION, false );
44      public static final DisplayTyperytype/DisplayType.html#DisplayType">DisplayType RESUBMIT_BACKOFFICE = new DisplayType( Mode.SELECT, false );
45      public static final DisplayTypeytype/DisplayType.html#DisplayType">DisplayType RESUBMIT_FRONTOFFICE = new DisplayType( Mode.EDITION, true );
46      public static final DisplayTyperytype/DisplayType.html#DisplayType">DisplayType COMPLETE_BACKOFFICE = new DisplayType( Mode.SELECT, false );
47      public static final DisplayTypeytype/DisplayType.html#DisplayType">DisplayType COMPLETE_FRONTOFFICE = new DisplayType( Mode.EDITION, true );
48      public static final DisplayTyperytype/DisplayType.html#DisplayType">DisplayType EDITION_FRONTOFFICE = new DisplayType( Mode.EDITION, true );
49      public static final DisplayTyperytype/DisplayType.html#DisplayType">DisplayType READONLY_BACKOFFICE = new DisplayType( Mode.READONLY, false );
50      public static final DisplayTypeytype/DisplayType.html#DisplayType">DisplayType READONLY_FRONTOFFICE = new DisplayType( Mode.READONLY, true );
51  
52      /**
53       * The display mode
54       *
55       */
56      public enum Mode
57      {
58          EDITION,
59          READONLY,
60          SELECT
61      }
62  
63      private final Mode _mode;
64      private final boolean _bIsFront;
65  
66      /**
67       * Constructor
68       * 
69       * @param mode
70       *            the mode
71       * @param bIsFront
72       *            {@code true} if the display is for front-office, {@code false} if it is for back-office
73       */
74      private DisplayType( Mode mode, boolean bIsFront )
75      {
76          _mode = mode;
77          _bIsFront = bIsFront;
78      }
79  
80      /**
81       * Gives the mode
82       * 
83       * @return the mode
84       */
85      public Mode getMode( )
86      {
87          return _mode;
88      }
89  
90      /**
91       * Tests if the display is for front-office or for back-office
92       * 
93       * @return {@code true} if the display is for front-office, {@code false} if it is for back-office
94       */
95      public boolean isFront( )
96      {
97          return _bIsFront;
98      }
99  }