hudson.plugins.analysis.core
Interface ResultAction<T extends BuildResult>

Type Parameters:
T - type of the result
All Superinterfaces:
hudson.model.Action, hudson.model.ModelObject
All Known Implementing Classes:
AbstractResultAction, MavenResultAction

public interface ResultAction<T extends BuildResult>
extends hudson.model.Action

Defines an action that is responsible for handling results of the given type T.

Author:
Ulli Hafner

Method Summary
 hudson.model.AbstractBuild<?,?> getBuild()
          Returns the associated build of this action.
 AbstractHealthDescriptor getHealthDescriptor()
          Gets the associated health descriptor.
 T getResult()
          Returns the current result of this action.
 ToolTipProvider getToolTipProvider()
          Returns the associated tool tip provider.
 boolean isSuccessful()
          Returns whether this build is successful with respect to the HealthDescriptor of this action.
 void setResult(T result)
          Sets the result for this build.
 
Methods inherited from interface hudson.model.Action
getDisplayName, getIconFileName, getUrlName
 

Method Detail

getResult

T getResult()
Returns the current result of this action.

Returns:
the current result

setResult

void setResult(T result)
Sets the result for this build.

Parameters:
result - the result to set

getBuild

hudson.model.AbstractBuild<?,?> getBuild()
Returns the associated build of this action.

Returns:
the associated build of this action

getToolTipProvider

ToolTipProvider getToolTipProvider()
Returns the associated tool tip provider.

Returns:
the tool tip provider

getHealthDescriptor

AbstractHealthDescriptor getHealthDescriptor()
Gets the associated health descriptor.

Returns:
the health descriptor

isSuccessful

boolean isSuccessful()
Returns whether this build is successful with respect to the HealthDescriptor of this action.

Returns:
true if the build is successful, false if the build has been set to Result.UNSTABLE or Result.FAILURE by this action.


Copyright © 2004-2012 Hudson. All Rights Reserved.