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.portal.business.dashboard;
35  
36  /**
37   * Dashboard filter
38   *
39   */
40  public class DashboardFilter
41  {
42      private Integer _nFilterColumn;
43      private Integer _nFilterOrder;
44  
45      /**
46       * Filter column
47       * 
48       * @return Filter column
49       */
50      public Integer getFilterColumn( )
51      {
52          return _nFilterColumn;
53      }
54  
55      /**
56       * Filter column
57       * 
58       * @param nFilterColumn
59       *            the Filter column
60       */
61      public void setFilterColumn( Integer nFilterColumn )
62      {
63          _nFilterColumn = nFilterColumn;
64      }
65  
66      /**
67       * Filter order
68       * 
69       * @return Filter order
70       */
71      public Integer getFilterOrder( )
72      {
73          return _nFilterOrder;
74      }
75  
76      /**
77       * Filter order
78       * 
79       * @param nFilterOrder
80       *            the Filter order
81       */
82      public void setFilterOrder( Integer nFilterOrder )
83      {
84          _nFilterOrder = nFilterOrder;
85      }
86  
87      /**
88       * true if {@link #getFilterOrder()} != null
89       * 
90       * @return <code>true</code> if {@link #getFilterOrder()} != null, <code>false</code> otherwise.
91       */
92      public boolean containsFilterOrder( )
93      {
94          return _nFilterOrder != null;
95      }
96  
97      /**
98       * true if {@link #getFilterColumn()} != null
99       * 
100      * @return <code>true</code> if {@link #getFilterColumn()} != null, <code>false</code> otherwise
101      */
102     public boolean containsFilterColumn( )
103     {
104         return _nFilterColumn != null;
105     }
106 
107     /**
108      *
109      * {@inheritDoc}
110      */
111     @Override
112     public String toString( )
113     {
114         return this.getClass( ).getName( ) + "[column=" + this.getFilterColumn( ) + ", order=" + this.getFilterOrder( ) + "]";
115     }
116 }