1 /*
2 * Copyright 2010 Capgemini and Contributors
3 *
4 * Licensed under the Apache License, Version 2.0 (the
5 * "License"); 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, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations under
14 * the License.
15 */
16 package net.sf.appstatus.core.check;
17
18 /**
19 * Status check result.
20 *
21 * @author Nicolas Richeton
22 */
23 public interface ICheckResult extends Comparable<ICheckResult> {
24
25 int ERROR = -1;
26 int OK = 0;
27
28 int getCode();
29
30 String getDescription();
31
32 String getGroup();
33
34 String getProbeName();
35
36 /**
37 * On error, should provide some advices on how to solve the issue. (Fix
38 * values in some property file, ensure remote service is running).
39 *
40 * @return
41 */
42 String getResolutionSteps();
43
44 /**
45 * If true, the application status will be set to ERROR. If false the error
46 * will be considered as a warning.
47 *
48 * @return
49 */
50 boolean isFatal();
51
52 void setDescription(String description);
53
54 void setResolutionSteps(String resolutionSteps);
55 }