File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\model\HealthReportingAction.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Stephen Connolly
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.model;
25
26 /**
27 * An {@link Action} that can return information about the health of the Job.
28 * <p>
29 * The health of a {@link Job} is the lowest health returned by the HealthReportingAction's
30 * that contribute to the Job.
31 * <p>
32 * When a particular Action "wins", it's gets to determine the icon and associated description.
33 * <p>
34 * This provides a mechanism for plugins to present important summary information
35 * on the {@link View} main pages without eating up significant screen real estate.
36 *
37 * @author Stephen Connolly
38 * @since 1.115
39 */
40 public interface HealthReportingAction extends Action {
41 /**
42 * Get this {@link Action}'s {@link HealthReport}.
43 *
44 * @return
45 * The health report for this instance of the Action or
46 * <code>null</code> if the Action does not want to
47 * contribute a HealthReport.
48 */
49 HealthReport getBuildHealth();
50 }
51