1 /*
2 * Copyright 2001-2004 The Apache Software Foundation.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.jdiagnose;
17
18 import java.io.Serializable;
19
20 /***
21 * Information about a DiagnosticResult. In the case of an
22 * exception, the summary would contain exception.getMessage()
23 * and the body the exceptions stacktrace.
24 *
25 * @author jmccrindle
26 */
27 public interface DiagnosticMessage extends Serializable {
28
29 /***
30 * A summary of the diagnostic result. Ideally should be
31 * only a single line.
32 *
33 * @return a summary of the diagnostic result message
34 */
35 String getSummary();
36
37 /***
38 * @return more details about the diagnostic result
39 */
40 String getBody();
41 }