hudson.model

Interface HealthReportingAction

All Superinterfaces:

Action, ModelObject

public interface HealthReportingAction
extends Action

An Action that can return information about the health of the Job.

The health of a Job is the lowest health returned by the HealthReportingAction's that contribute to the Job.

When a particular Action "wins", it's gets to determine the icon and associated description.

This provides a mechanism for plugins to present important summary information on the View main pages without eating up significant screen real estate.

Since:

1.115

Author:

Stephen Connolly

Method Summary

Modifier and Type	Method and Description
HealthReport	getBuildHealth() Get this Action's HealthReport.

Methods inherited from interface hudson.model.Action

getDisplayName, getIconFileName, getUrlName

Method Detail

getBuildHealth

HealthReport getBuildHealth()

Get this Action's HealthReport.

Returns:

The health report for this instance of the Action or null if the Action does not want to contribute a HealthReport.