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.folderlisting.business;
35
36 import fr.paris.lutece.util.xml.XmlUtil;
37
38 import javax.servlet.http.HttpServletRequest;
39
40
41 /**
42 * This class represents the business object FolderListingFile
43 */
44 public class FolderListingDirectory
45 {
46 ///////////////////////////////////////////////////////////////////////
47 // Constants
48
49 // Xml Tags
50 private static final String TAG_DIRECTORY = "directory";
51 private static final String TAG_DIRECTORY_NAME = "directory-name";
52 private static final String TAG_DIRECTORY_DATE = "directory-date";
53 private static final String TAG_DIRECTORY_PATH = "directory-path";
54
55 // Variables declarations
56 private String _strName;
57 private String _strDate;
58 private String _strPath;
59
60 /**
61 * Returns the Name
62 *
63 * @return The Name
64 */
65 public String getName( )
66 {
67 return _strName;
68 }
69
70 /**
71 * Sets the Name
72 *
73 * @param strName The Name
74 */
75 public void setName( String strName )
76 {
77 _strName = strName;
78 }
79
80 /**
81 * Returns the Date
82 *
83 * @return The Date
84 */
85 public String getDate( )
86 {
87 return _strDate;
88 }
89
90 /**
91 * Sets the Date
92 *
93 * @param strDate The Date
94 */
95 public void setDate( String strDate )
96 {
97 _strDate = strDate;
98 }
99
100 /**
101 * Returns the Path
102 *
103 * @return The Path
104 */
105 public String getPath( )
106 {
107 return _strPath;
108 }
109
110 /**
111 * Sets the Path
112 *
113 * @param strPath The Path
114 */
115 public void setPath( String strPath )
116 {
117 _strPath = strPath;
118 }
119
120 /**
121 * Builds the XML content of this FolderListingFile and returns it
122 * @param request The HttpServletRequest
123 * @return the Xml content of this FolderListingFile
124 */
125 public String getXml( HttpServletRequest request )
126 {
127 StringBuffer strXml = new StringBuffer( );
128 XmlUtil.beginElement( strXml, TAG_DIRECTORY );
129
130 XmlUtil.addElement( strXml, TAG_DIRECTORY_NAME, getName( ) );
131 XmlUtil.addElement( strXml, TAG_DIRECTORY_DATE, getDate( ) );
132 XmlUtil.addElement( strXml, TAG_DIRECTORY_PATH, getPath( ) );
133
134 XmlUtil.endElement( strXml, TAG_DIRECTORY );
135
136 return strXml.toString( );
137 }
138 }