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.web.action;
35
36 import fr.paris.lutece.plugins.directory.business.Directory;
37
38 import java.util.List;
39
40 /**
41 * implementation of IDirectorySearchFields for storing in session the search filter and sort filter used in DirectoryApp
42 *
43 * @author merlinfe
44 *
45 */
46 public class DirectorySiteSearchFields extends DefaultDirectorySearchFields
47 {
48 /**
49 *
50 */
51 private static final long serialVersionUID = -3832842315618063894L;
52 private List<String> _roleKeyList;
53 private boolean _bIncludeRoleNull;
54 private boolean _bIncludeRoleNone;
55
56 /**
57 *
58 * @return true if the filter must included the role none
59 */
60 public boolean isIncludeRoleNone( )
61 {
62 return _bIncludeRoleNone;
63 }
64
65 /**
66 * used if the record must be filter by role
67 *
68 * @param bIncludeRoleNone
69 * true if the filter must included the role none
70 */
71 public void setIncludeRoleNone( boolean bIncludeRoleNone )
72 {
73 _bIncludeRoleNone = bIncludeRoleNone;
74 }
75
76 /**
77 * a list of key role
78 *
79 * @param roleKeyList
80 * a list of key role
81 */
82 public void setRoleKeyList( List<String> roleKeyList )
83 {
84 _roleKeyList = roleKeyList;
85 }
86
87 /**
88 * a list of key role
89 *
90 * @return a list of key role
91 */
92 public List<String> getRoleKeyList( )
93 {
94 return _roleKeyList;
95 }
96
97 /**
98 * used if the record must be filter by role
99 *
100 * @param _bIncludeRoleNull
101 * true if the filter must included the role null
102 */
103 public void setIncludeRoleNull( boolean _bIncludeRoleNull )
104 {
105 this._bIncludeRoleNull = _bIncludeRoleNull;
106 }
107
108 /**
109 *
110 * @return true if the filter must included the role null
111 */
112 public boolean isIncludeRoleNull( )
113 {
114 return _bIncludeRoleNull;
115 }
116
117 /*
118 * (non-Javadoc)
119 *
120 * @see
121 * fr.paris.lutece.plugins.directory.web.action.DefaultDirectorySearchFields#getDefaultIdSortEntry(fr.paris.lutece.plugins.directory.business.Directory)
122 */
123 public String getDefaultIdSortEntry( Directory directory )
124 {
125 return directory.getIdSortEntryFront( );
126 }
127
128 /*
129 * (non-Javadoc)
130 *
131 * @see
132 * fr.paris.lutece.plugins.directory.web.action.DefaultDirectorySearchFields#isDefaultAscendingSort(fr.paris.lutece.plugins.directory.business.Directory)
133 */
134 public boolean isDefaultAscendingSort( Directory directory )
135 {
136 return directory.isAscendingSort( );
137 }
138 }