hudson.plugins.promoted_builds
Class PromotedBuildAction

java.lang.Object
  hudson.plugins.promoted_builds.PromotedBuildAction

All Implemented Interfaces:

hudson.model.Action, hudson.model.BuildBadgeAction, hudson.model.ModelObject

public final class PromotedBuildAction
extends java.lang.Object
implements hudson.model.BuildBadgeAction

Action for AbstractBuild indicating that it's promoted.

Author:

Kohsuke Kawaguchi

Field Summary

hudson.model.AbstractBuild<?,?>

owner

Constructor Summary

PromotedBuildAction(hudson.model.AbstractBuild<?,?> owner)

PromotedBuildAction(hudson.model.AbstractBuild<?,?> owner, Status firstStatus)

Method Summary

boolean	add(Status status) Called when the build is qualified.
boolean	canPromote()
boolean	contains(PromotionProcess process) Checks if the given criterion is already promoted.
boolean	contains(java.lang.String name) Checks if the given criterion is already promoted.
void	doForcePromotion(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, java.lang.String name) Force a promotion.
java.lang.String	getDisplayName()
Status	getDynamic(java.lang.String name, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Binds Status to URL hierarchy by its name.
java.lang.String	getIconFileName()
java.util.List<PromotionProcess>	getPendingPromotions() Gets list of PromotionProcesss that are not yet attained.
hudson.model.AbstractProject<?,?>	getProject() Gets the owning project.
Status	getPromotion(java.lang.String name) Finds the Status that has matching Status.name value.
java.util.List<Status>	getPromotions() Gets the read-only view of all the promotions that this build achieved.
java.lang.String	getUrlName()
boolean	hasPromotion()

Methods inherited from class java.lang.Object

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

Field Detail

owner

public final hudson.model.AbstractBuild<?,?> owner

Constructor Detail

PromotedBuildAction

public PromotedBuildAction(hudson.model.AbstractBuild<?,?> owner)

PromotedBuildAction

public PromotedBuildAction(hudson.model.AbstractBuild<?,?> owner,
                           Status firstStatus)

Method Detail

getProject

public hudson.model.AbstractProject<?,?> getProject()

Gets the owning project.

contains

public boolean contains(PromotionProcess process)

Checks if the given criterion is already promoted.

contains

public boolean contains(java.lang.String name)

Checks if the given criterion is already promoted.

add

public boolean add(Status status)
            throws java.io.IOException

Called when the build is qualified.

Throws:

java.io.IOException

getPromotions

public java.util.List<Status> getPromotions()

Gets the read-only view of all the promotions that this build achieved.

getPromotion

public Status getPromotion(java.lang.String name)

Finds the Status that has matching Status.name value. Or null if not found.

hasPromotion

public boolean hasPromotion()

canPromote

public boolean canPromote()

getPendingPromotions

public java.util.List<PromotionProcess> getPendingPromotions()

Gets list of PromotionProcesss that are not yet attained.

Returns:

can be empty but never null.

getIconFileName

public java.lang.String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

public java.lang.String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

getDynamic

public Status getDynamic(java.lang.String name,
                         org.kohsuke.stapler.StaplerRequest req,
                         org.kohsuke.stapler.StaplerResponse rsp)

Binds Status to URL hierarchy by its name.

doForcePromotion

public void doForcePromotion(org.kohsuke.stapler.StaplerRequest req,
                             org.kohsuke.stapler.StaplerResponse rsp,
                             @QueryParameter(value="name")
                             java.lang.String name)
                      throws java.io.IOException

Force a promotion.

Throws:

java.io.IOException