1 /*
2 * Java HTML Tidy - JTidy
3 * HTML parser and pretty printer
4 *
5 * Copyright (c) 1998-2000 World Wide Web Consortium (Massachusetts
6 * Institute of Technology, Institut National de Recherche en
7 * Informatique et en Automatique, Keio University). All Rights
8 * Reserved.
9 *
10 * Contributing Author(s):
11 *
12 * Dave Raggett <dsr@w3.org>
13 * Andy Quick <ac.quick@sympatico.ca> (translation to Java)
14 * Gary L Peskin <garyp@firstech.com> (Java development)
15 * Sami Lempinen <sami@lempinen.net> (release management)
16 * Fabrizio Giustina <fgiust at users.sourceforge.net>
17 * Vlad Skarzhevskyy <vlads at users.sourceforge.net> (JTidy servlet development)
18 *
19 * The contributing author(s) would like to thank all those who
20 * helped with testing, bug fixes, and patience. This wouldn't
21 * have been possible without all of you.
22 *
23 * COPYRIGHT NOTICE:
24 *
25 * This software and documentation is provided "as is," and
26 * the copyright holders and contributing author(s) make no
27 * representations or warranties, express or implied, including
28 * but not limited to, warranties of merchantability or fitness
29 * for any particular purpose or that the use of the software or
30 * documentation will not infringe any third party patents,
31 * copyrights, trademarks or other rights.
32 *
33 * The copyright holders and contributing author(s) will not be
34 * liable for any direct, indirect, special or consequential damages
35 * arising out of any use of the software or documentation, even if
36 * advised of the possibility of such damage.
37 *
38 * Permission is hereby granted to use, copy, modify, and distribute
39 * this source code, or portions hereof, documentation and executables,
40 * for any purpose, without fee, subject to the following restrictions:
41 *
42 * 1. The origin of this source code must not be misrepresented.
43 * 2. Altered versions must be plainly marked as such and must
44 * not be misrepresented as being the original source.
45 * 3. This Copyright notice may not be removed or altered from any
46 * source or altered source distribution.
47 *
48 * The copyright holders and contributing author(s) specifically
49 * permit, without fee, and encourage the use of this source code
50 * as a component for supporting the Hypertext Markup Language in
51 * commercial products. If you use this source code in a product,
52 * acknowledgment is not required but would be appreciated.
53 *
54 */
55 package org.w3c.tidy.servlet;
56 /*
57 * Created on 08.10.2004 by vlads
58 */
59 import java.util.List;
60
61 import org.w3c.tidy.TidyMessageListener;
62
63 /***
64 * Data to store Validation results and error.
65 *
66 * @see org.w3c.tidy.servlet.data.DefaultResponseRecord
67 *
68 * @author Vlad Skarzhevskyy <a href="mailto:skarzhevskyy@gmail.com">skarzhevskyy@gmail.com</a>
69 * @version $Revision: 1.3 $ ($Author: vlads $)
70 */
71 public interface ResponseRecord extends TidyMessageListener
72 {
73 /***
74 * @return Returns the requestID.
75 */
76 Object getRequestID();
77 /***
78 * @param requestID The requestID to set.
79 */
80 void setRequestID(Object requestID);
81 /***
82 * @return Returns the input html.
83 */
84 String getHtmlInput();
85 /***
86 * @param html The input html to set.
87 */
88 void setHtmlInput(String html);
89 /***
90 * @return Returns the htmlResult.
91 */
92 String getHtmlOutput();
93 /***
94 * @param html The htmlOutput to set.
95 */
96 void setHtmlOutput(String html);
97 /***
98 * @return Returns the number of parse errors.
99 */
100 int getParseErrors();
101 /***
102 * @return Returns the number of parse warnings.
103 */
104 int getParseWarnings();
105 /***
106 * @return Returns the JTidy messages.
107 * @see org.w3c.tidy.TidyMessage
108 */
109 List getMessages();
110 /***
111 * @return Returns the JTidy parsing time in milliseconds.
112 */
113 long getParsTime();
114 /***
115 * @param parsTime The parsTime to set.
116 */
117 void setParsTime(long parsTime);
118 /***
119 * @return Returns the when.
120 */
121 long getWhen();
122 /***
123 * @return Returns the part of ImageName shown as icon or null to use default implementation
124 */
125 String getImageName();
126 }