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.formengine.business;
35
36
37 /**
38 * NoticeGroupFilter
39 */
40 public class NoticeGroupFilter
41 {
42 public static final String ALL_STRING = "all";
43 public static final int ALL_INT = -1;
44 public static final int FILTER_FALSE = 0;
45 public static final int FILTER_TRUE = 1;
46 private int _nIsEnabled = ALL_INT;
47 private String _strForm = ALL_STRING;
48 private String _strWorkgroup = ALL_STRING;
49
50 /**
51 *
52 * @return 1 if the forms return must be enabled
53 * 0 if the forms return must be disabled
54 */
55 public int getIsEnabled( )
56 {
57 return _nIsEnabled;
58 }
59
60 /**
61 * Set 1 if the forms return must be enabled
62 * 0 if the forms return must be disabled
63 * @param idState 1 if the forms return must be enabled
64 * 0 if the forms return must be disabled
65 */
66 public void setIsEnbled( int idState )
67 {
68 _nIsEnabled = idState;
69 }
70
71 /**
72 *
73 * @return true if the filter contain form state
74 */
75 public boolean containsIsEnabled( )
76 {
77 return ( _nIsEnabled != ALL_INT );
78 }
79
80 /**
81 *
82 * @return the workgroup of the search forms
83 */
84 public String getWorkgroup( )
85 {
86 return _strWorkgroup;
87 }
88
89 /**
90 * set the workgroup of the search forms
91 * @param workgroup the workgroup of the notice
92 */
93 public void setWorkGroup( String workgroup )
94 {
95 _strWorkgroup = workgroup;
96 }
97
98 /**
99 *
100 * @return true if the filter contain workgroup criteria
101 */
102 public boolean containsWorkgroupCriteria( )
103 {
104 return ( !_strWorkgroup.equals( ALL_STRING ) );
105 }
106
107 /**
108 * "Getter method" for {@link #_strForm}
109 * @return value of {@link #_strForm}
110 */
111 public String getForm( )
112 {
113 return _strForm;
114 }
115
116 /**
117 * "Setter method" for {@link #_strForm}
118 * @param strForm new value of {@link #_strForm}
119 */
120 public void setForm( String strForm )
121 {
122 _strForm = strForm;
123 }
124
125 /**
126 *
127 * @return true if the filter contain form criteria
128 */
129 public boolean containsFormCriteria( )
130 {
131 return ( !_strForm.equals( ALL_STRING ) );
132 }
133 }