com.michelin.cio.hudson.plugins.clearcaseucmbaseline
Class ClearCaseUcmBaselineParameterDefinition

java.lang.Object
  hudson.model.ParameterDefinition
      com.michelin.cio.hudson.plugins.clearcaseucmbaseline.ClearCaseUcmBaselineParameterDefinition

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.ParameterDefinition>, java.io.Serializable, java.lang.Comparable<ClearCaseUcmBaselineParameterDefinition>

public class ClearCaseUcmBaselineParameterDefinition
extends hudson.model.ParameterDefinition
implements java.lang.Comparable<ClearCaseUcmBaselineParameterDefinition>

Defines a new ParameterDefinition to be displayed at the top of the configuration page of AbstractProjects.

For this parameter to actually work, it is mandatory for the AbstractProjects using it to set their SCM to be ClearCaseUcmBaselineSCM. If not set, the build will be aborted (see ClearCaseUcmBaselineParameterValue.createBuildWrapper(hudson.model.AbstractBuild) which does this check).

When used, this parameter will request the user to select a ClearCase UCM baseline at run-time by displaying a drop-down list. See ClearCaseUcmBaselineParameterValue.

This parameter consists in a set of attributes to be set at config-time, the most important being:

• The ClearCase UCM PVOB name;
• The ClearCase UCM component name;
• The ClearCase UCM promotion level (e.g. RELEASED);
• The ClearCase UCM stream;
• The ClearCase UCM view to create name.

The following attribute is then asked at run-time:

• The ClearCase UCM baseline.

Author:

Romain Seguy (http://openromain.blogspot.com)

See Also:

Serialized Form

Nested Class Summary

static class

ClearCaseUcmBaselineParameterDefinition.DescriptorImpl

Nested classes/interfaces inherited from class hudson.model.ParameterDefinition

hudson.model.ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

static java.lang.String

PARAMETER_NAME

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

ClearCaseUcmBaselineParameterDefinition(java.lang.String pvob, java.lang.String component, java.lang.String promotionLevel, java.lang.String stream, java.lang.String restrictions, java.lang.String viewName, java.lang.String mkviewOptionalParam, boolean snapshotView, boolean useUpdate, boolean forceRmview, boolean excludeElementCheckedout, java.lang.String moreRecentThan, java.lang.String uuid)

Method Summary

int	compareTo(ClearCaseUcmBaselineParameterDefinition pd)
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req)
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
java.util.List<java.lang.String>	getBaselines() Returns a list of ClearCase UCM baselines to be displayed in ClearCaseUcmBaselineParameterDefinition/index.jelly (or null if something wrong happens).
java.lang.String	getComponent()
boolean	getExcludeElementCheckedout()
boolean	getForceRmview()
java.lang.String	getMkviewOptionalParam()
java.lang.String	getMoreRecentThan()
java.lang.String	getPromotionLevel()
java.lang.String	getPvob()
java.lang.String	getRestrictions()
java.util.List<java.lang.String>	getRestrictionsAsList()
boolean	getSnapshotView()
java.lang.String	getStream()
boolean	getUseUpdate()
java.lang.String	getViewName()

Methods inherited from class hudson.model.ParameterDefinition

all, createValue, getDefaultParameterValue, getDescription, getDescriptor, getName

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_NAME

public static final java.lang.String PARAMETER_NAME

See Also:

Constant Field Values

Constructor Detail

ClearCaseUcmBaselineParameterDefinition

@DataBoundConstructor
public ClearCaseUcmBaselineParameterDefinition(java.lang.String pvob,
                                                                    java.lang.String component,
                                                                    java.lang.String promotionLevel,
                                                                    java.lang.String stream,
                                                                    java.lang.String restrictions,
                                                                    java.lang.String viewName,
                                                                    java.lang.String mkviewOptionalParam,
                                                                    boolean snapshotView,
                                                                    boolean useUpdate,
                                                                    boolean forceRmview,
                                                                    boolean excludeElementCheckedout,
                                                                    java.lang.String moreRecentThan,
                                                                    java.lang.String uuid)

Method Detail

compareTo

public int compareTo(ClearCaseUcmBaselineParameterDefinition pd)

Specified by:

compareTo in interface java.lang.Comparable<ClearCaseUcmBaselineParameterDefinition>

createValue

public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest req)

Specified by:

createValue in class hudson.model.ParameterDefinition

createValue

public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest req,
                                               net.sf.json.JSONObject formData)

Specified by:

createValue in class hudson.model.ParameterDefinition

getBaselines

public java.util.List<java.lang.String> getBaselines()
                                              throws java.io.IOException,
                                                     java.lang.InterruptedException

Returns a list of ClearCase UCM baselines to be displayed in ClearCaseUcmBaselineParameterDefinition/index.jelly (or null if something wrong happens).

Throws:

java.io.IOException

java.lang.InterruptedException

getComponent

public java.lang.String getComponent()

getExcludeElementCheckedout

public boolean getExcludeElementCheckedout()

getForceRmview

public boolean getForceRmview()

getMkviewOptionalParam

public java.lang.String getMkviewOptionalParam()

getMoreRecentThan

public java.lang.String getMoreRecentThan()

getPromotionLevel

public java.lang.String getPromotionLevel()

getPvob

public java.lang.String getPvob()

getRestrictions

public java.lang.String getRestrictions()

getRestrictionsAsList

public java.util.List<java.lang.String> getRestrictionsAsList()

getSnapshotView

public boolean getSnapshotView()

getStream

public java.lang.String getStream()

getUseUpdate

public boolean getUseUpdate()

getViewName

public java.lang.String getViewName()