1 /*
2 * Copyright (c) 2002-2017, 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.directory.business.parameter;
35
36 import java.util.ArrayList;
37 import java.util.List;
38
39 /**
40 *
41 * DirectoryParameterFilter
42 *
43 */
44 public class DirectoryParameterFilter
45 {
46 private boolean _bExcludeParameterKeys;
47 private List<String> _listParameterKeys;
48
49 /**
50 * Constructor
51 */
52 public DirectoryParameterFilter( )
53 {
54 _bExcludeParameterKeys = false;
55 }
56
57 /**
58 * Check if the filter contains a list of parameters keys
59 *
60 * @return true if it contains a list of parameter keys
61 */
62 public boolean containsListParameterKeys( )
63 {
64 return _listParameterKeys != null;
65 }
66
67 /**
68 * Add a parameter key to the list to filter
69 *
70 * @param strParameterKey
71 * the parameter key
72 */
73 public void addParameterKey( String strParameterKey )
74 {
75 if ( _listParameterKeys == null )
76 {
77 _listParameterKeys = new ArrayList<String>( );
78 }
79
80 _listParameterKeys.add( strParameterKey );
81 }
82
83 /**
84 * Get the list of parameter keys
85 *
86 * @return the list of parameter keys
87 */
88 public List<String> getListParameterKeys( )
89 {
90 return _listParameterKeys;
91 }
92
93 /**
94 * Check if the filter must exclude the list of parameter keys
95 *
96 * @return true if the filter must exclude the list of parameter keys, false otherwise
97 */
98 public boolean excludeParameterKeys( )
99 {
100 return _bExcludeParameterKeys;
101 }
102
103 /**
104 * Set true if the filter must exclude the list of parameter keys, false otherwise
105 *
106 * @param bExcludeParameterKeys
107 * true if the filter must exclude the list of parameter keys, false otherwise
108 */
109 public void setExcludeParameterKeys( boolean bExcludeParameterKeys )
110 {
111 _bExcludeParameterKeys = bExcludeParameterKeys;
112 }
113 }