com.ibm.team.build.internal.hjplugin
Class RTCBuildResultAction

java.lang.Object
  com.ibm.team.build.internal.hjplugin.RTCBuildResultAction

All Implemented Interfaces:

hudson.model.Action, hudson.model.EnvironmentContributingAction, hudson.model.ModelObject, Serializable

public class RTCBuildResultAction
extends Object
implements Serializable, hudson.model.Action, hudson.model.EnvironmentContributingAction

An action that is associated with a Hudson/Jenkins build. Serialized so that it can contribute information to the Hudson/Jenkins build result. Contributes to the H/J build a link to the RTC build result. Contributes to the environment properties that come from the RTC build definition & engine Contains information about the RTC build result so that other extensions to the build can access it (example: RunListener to be able to terminate the RTC build result).

See Also:

Serialized Form

Method Summary

void	addBuildProperties(Map<String,String> buildProperties) Adds to the RTC Scm build the properties obtained from the build engine and build definition.
void	buildEnvVars(hudson.model.AbstractBuild<?,?> build, hudson.EnvVars env)
boolean	createdBuildResult()
String	getDisplayName()
String	getIconFileName()
RTCScm	getScm()
String	getUrlName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

buildEnvVars

public void buildEnvVars(hudson.model.AbstractBuild<?,?> build,
                         hudson.EnvVars env)

Specified by:

buildEnvVars in interface hudson.model.EnvironmentContributingAction

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

createdBuildResult

public boolean createdBuildResult()

Returns:

true if the build was inititiated in Hudson/Jenkins and the plugin created a build result in RTC (and this build is responsible for the lifecycle). false if the build result was not created by this build.

addBuildProperties

public void addBuildProperties(Map<String,String> buildProperties)

Adds to the RTC Scm build the properties obtained from the build engine and build definition.

Parameters:

buildProperties - The build properties to include

getScm

public RTCScm getScm()

Returns:

The SCM configuration for the build that created this action