com.atlassian.bamboo.emailer.strategy
Interface EmailStrategy

All Known Implementing Classes:
AbstractEmailStrategy, AlwaysEmailStrategy, EmailErrorsAndFirstSuccessfulBuildStrategy, NeverEmailStrategy

public interface EmailStrategy

Defines a strategy for deciding if Bamboo should email the build results.


Method Summary
 java.lang.String getLabel()
          Obtain a description of the strategy for displaying in the GUI
 java.lang.String getName()
          Used to identify the strategy within the UI
 boolean shouldEmailBuildResults(BuildResults buildResults, BuildState previousBuildState)
          Should we email the given buildResults, based on the previousBuildState?
 

Method Detail

getLabel

java.lang.String getLabel()
Obtain a description of the strategy for displaying in the GUI

Returns:
the descriptive label for the GUI

getName

java.lang.String getName()
Used to identify the strategy within the UI

Returns:
The name

shouldEmailBuildResults

boolean shouldEmailBuildResults(BuildResults buildResults,
                                BuildState previousBuildState)
Should we email the given buildResults, based on the previousBuildState?

Parameters:
buildResults - The build results to email
previousBuildState - The status of the previous build
Returns:
true iff the email should be sent


Copyright © 2008 Atlassian Pty Ltd. All Rights Reserved.