com.ibm.team.build.common.model

Interface IBuildDefinition

All Superinterfaces:

IAuditable, IAuditableHandle, IBuildDefinitionHandle, IBuildItem, IBuildItemHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle

public interface IBuildDefinition
extends IBuildDefinitionHandle, IAuditable, IBuildItem

The build definition is a primary identifier for a set of builds. A definition is composed of one or more configuration elements that make up the configurable data in the definition. Example configuration elements provided by com.ibm.team.build are General, Ant, Schedule, Expected Contributions, and Properties. In addition, new configuration elements can be contributed via the com.ibm.team.build.common.buildConfigurationElements extension point.

Since:

0.5

Field Summary

Fields

Modifier and Type	Field and Description
static IItemType	ITEM_TYPE The item type for this auditable.
static java.lang.String	PROPERTY_BUILD_AVERAGE_DATA The name of the build average data property.
static java.lang.String	PROPERTY_BUILD_RESULT_PRUNING_POLICY The name of the build result pruning policy property.
static java.lang.String	PROPERTY_BUILD_SCHEDULE The name of the build schedule property.
static java.lang.String	PROPERTY_CONFIGURATION_ELEMENTS The name of the configuration elements property.
static java.lang.String	PROPERTY_DESCRIPTION The name of the description property.
static java.lang.String	PROPERTY_EXPECTED_CONTRIBUTIONS The name of the expected contributions property.
static java.lang.String	PROPERTY_ID The name of the build definition id property.
static java.lang.String	PROPERTY_IGNORE_WARNINGS The name of the ignore warnings property.
static java.lang.String	PROPERTY_PROCESS_AREA The name of the build definition process area property.
static java.lang.String	PROPERTY_PROPERTIES The name of the properties property.

Fields inherited from interface com.ibm.team.build.common.model.IBuildItemHandle

PROPERTIES_COMPLETE, PROPERTIES_REQUIRED

Fields inherited from interface com.ibm.team.repository.common.IAuditable

MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY

Fields inherited from interface com.ibm.team.repository.common.IItem

CONTEXT_ID_PROPERTY, ITEM_ID_PROPERTY, MAX_LARGE_STRING_BYTES, MAX_MEDIUM_STRING_BYTES, MAX_SMALL_STRING_BYTES, MODIFIED_BY_PROPERTY, MODIFIED_PROPERTY, STATE_ID_PROPERTY

Method Summary

Methods

Modifier and Type	Method and Description
IBuildDefinition	copyDefinition() Make a copy of this definition.
IBuildAverageDataHandle	getBuildAverageData() Get the average data for the build definition.
IBuildResultPruningPolicy	getBuildResultPruningPolicy() Get the pruning policy for the build definition.
IBuildSchedule	getBuildSchedule() Retrieves the schedule for the build.
IBuildConfigurationElement	getConfigurationElement(java.lang.String elementId) Get the configuration element with the given id.
java.util.List	getConfigurationElements() Get the configuration elements for this build definition.
java.lang.String	getConfigurationPropertyValue(java.lang.String elementId, java.lang.String name, java.lang.String defaultValue) Get the value of the configuration property with the given name in the configuration element with the given id.
java.lang.String	getDescription() Retrieves the description of the build definition.
java.util.List	getExpectedContributions() Retrieves the expected contributions for this build definition.
java.lang.String	getId() Retrieves the build definition id.
IProcessAreaHandle	getProcessArea() Retrieves the process area the build definition is associated with.
java.util.List	getProperties() Get the build properties.
IBuildProperty	getProperty(java.lang.String name) Get the property with the given name.
java.lang.String	getPropertyValue(java.lang.String name, java.lang.String defaultValue) Get the value of the property with the given name.
void	initializeConfiguration(IBuildConfigurationElement element) Initialize the build definition from the given configuration element.
void	initializeConfiguration(IBuildDefinitionTemplate template) Initialize the build definition from the given template.
boolean	isIgnoreWarnings() Determines if warnings will be ignored when computing the overall status for builds of this type.
void	removeConfigurationProperty(java.lang.String elementId, java.lang.String name) Removes the configuration property with the given name in the configuration element with the given id.
void	setBuildAverageData(IBuildAverageDataHandle buildAverageData) Set the average data for the build definition.
void	setBuildResultPruningPolicy(IBuildResultPruningPolicy policy) Set the build definition pruning policy.
void	setBuildSchedule(IBuildSchedule buildSchedule) Set the build schedule.
void	setConfigurationProperty(java.lang.String elementId, java.lang.String name, java.lang.String value) Set the value of the configuration property with the given name in the configuration element with the given id.
void	setDescription(java.lang.String description) Sets the description of the build definition.
void	setId(java.lang.String id) Sets the build definition id.
void	setIgnoreWarnings(boolean ignoreWarnings) Set whether or not warnings should be ignored when computing the overall status for builds of this type.
void	setProcessArea(IProcessAreaHandle processAreaHandle) Sets the process area the build definition is associated with.
void	setProperty(java.lang.String name, java.lang.String value) Set the value of the property with the given name.

Methods inherited from interface com.ibm.team.repository.common.IAuditable

getMergePredecessorState, getPredecessorState

Methods inherited from interface com.ibm.team.repository.common.IManagedItem

isNewItem

Methods inherited from interface com.ibm.team.repository.common.IItem

getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId

Methods inherited from interface com.ibm.team.repository.common.IItemHandle

equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size

Field Detail

ITEM_TYPE

static final IItemType ITEM_TYPE

The item type for this auditable.

PROPERTY_BUILD_AVERAGE_DATA

static final java.lang.String PROPERTY_BUILD_AVERAGE_DATA

The name of the build average data property.

PROPERTY_BUILD_RESULT_PRUNING_POLICY

static final java.lang.String PROPERTY_BUILD_RESULT_PRUNING_POLICY

The name of the build result pruning policy property.

PROPERTY_BUILD_SCHEDULE

static final java.lang.String PROPERTY_BUILD_SCHEDULE

The name of the build schedule property.

PROPERTY_DESCRIPTION

static final java.lang.String PROPERTY_DESCRIPTION

The name of the description property.

PROPERTY_ID

static final java.lang.String PROPERTY_ID

The name of the build definition id property.

PROPERTY_IGNORE_WARNINGS

static final java.lang.String PROPERTY_IGNORE_WARNINGS

The name of the ignore warnings property.

PROPERTY_PROPERTIES

static final java.lang.String PROPERTY_PROPERTIES

The name of the properties property.

PROPERTY_PROCESS_AREA

static final java.lang.String PROPERTY_PROCESS_AREA

The name of the build definition process area property.

Since:

0.7

PROPERTY_EXPECTED_CONTRIBUTIONS

static final java.lang.String PROPERTY_EXPECTED_CONTRIBUTIONS

The name of the expected contributions property.

PROPERTY_CONFIGURATION_ELEMENTS

static final java.lang.String PROPERTY_CONFIGURATION_ELEMENTS

The name of the configuration elements property.

Method Detail

getId

java.lang.String getId()

Retrieves the build definition id.

Returns:

The build definition id.

setId

void setId(java.lang.String id)

Sets the build definition id. The id must be unique across the repository.

Parameters:

id - The build definition id.

getExpectedContributions

java.util.List getExpectedContributions()

Retrieves the expected contributions for this build definition. The expected contributions are valid only if the definition contains the configuration element for IExpectedContributionsConfigurationElement.ELEMENT_ID.

Returns:

A List of type IExpectedContribution.

getBuildResultPruningPolicy

IBuildResultPruningPolicy getBuildResultPruningPolicy()

Get the pruning policy for the build definition.

Returns:

The pruning policy.

setBuildResultPruningPolicy

void setBuildResultPruningPolicy(IBuildResultPruningPolicy policy)

Set the build definition pruning policy.

Parameters:

policy - The pruning policy for the build definition.

getProperties

java.util.List getProperties()

Get the build properties. These properties are valid only if the definition contains the configuration element for IPropertiesConfigurationElement.ELEMENT_ID.

Returns:

A list whose elements are of type IBuildProperty.

getProperty

IBuildProperty getProperty(java.lang.String name)

Get the property with the given name. Return null if a property with the given name does not exist.

Parameters:

name - The property name.

Returns:

A property, or null if a property with the given name does not exist.

getPropertyValue

java.lang.String getPropertyValue(java.lang.String name,
                                java.lang.String defaultValue)

Get the value of the property with the given name. Returns the given default value if a property with the given name does not exist.

Parameters:

name - The property name.

defaultValue - The default value (may be null).

Returns:

The value of the property, or the default value if a property with the given name does not exist.

Since:

0.8

setProperty

void setProperty(java.lang.String name,
               java.lang.String value)

Set the value of the property with the given name. The property is added if it does not already exist.

Parameters:

name - The property name.

value - The property value.

Since:

0.8

getDescription

java.lang.String getDescription()

Retrieves the description of the build definition. It's intended to be a more detailed description of the build definition than the label.

Returns:

The description of the build definition.

setDescription

void setDescription(java.lang.String description)

Sets the description of the build definition. It's intended to be a more detailed description of the build definition than the label.

Parameters:

description - The description of the build definition.

getBuildSchedule

IBuildSchedule getBuildSchedule()

Retrieves the schedule for the build. The schedule is valid only if the definition contains the configuration element for IScheduleConfigurationElement.ELEMENT_ID.

Returns:

The build schedule.

setBuildSchedule

void setBuildSchedule(IBuildSchedule buildSchedule)

Set the build schedule. The schedule is valid only if the definition contains the configuration element for IScheduleConfigurationElement.ELEMENT_ID.

Parameters:

buildSchedule - The schedule for the build definition.

isIgnoreWarnings

boolean isIgnoreWarnings()

Determines if warnings will be ignored when computing the overall status for builds of this type.

Returns:

Whether or not warnings will be ignored when computing the overall status for builds of this type.

setIgnoreWarnings

void setIgnoreWarnings(boolean ignoreWarnings)

Set whether or not warnings should be ignored when computing the overall status for builds of this type. The setting only affects future builds, not existing builds.

Parameters:

ignoreWarnings -

getBuildAverageData

IBuildAverageDataHandle getBuildAverageData()

Get the average data for the build definition.

Returns:

The average data for the build definition. Will be null if there is no average data for the build definition.

setBuildAverageData

void setBuildAverageData(IBuildAverageDataHandle buildAverageData)

Set the average data for the build definition.

Parameters:

buildAverageData - The average data for the build definition.

getProcessArea

IProcessAreaHandle getProcessArea()

Retrieves the process area the build definition is associated with.

Returns:

the process area the build definition is associated with.

Since:

0.7

setProcessArea

void setProcessArea(IProcessAreaHandle processAreaHandle)

Sets the process area the build definition is associated with.

Parameters:

processAreaHandle - The process area to associate the build definition with.

Since:

0.7

getConfigurationElements

java.util.List getConfigurationElements()

Get the configuration elements for this build definition.

Returns:

A List whose elements are of type IBuildConfigurationElement.

getConfigurationElement

IBuildConfigurationElement getConfigurationElement(java.lang.String elementId)

Get the configuration element with the given id.

Parameters:

elementId - The element id.

Returns:

A configuration element, or null if an element with the given id does not exist.

getConfigurationPropertyValue

java.lang.String getConfigurationPropertyValue(java.lang.String elementId,
                                             java.lang.String name,
                                             java.lang.String defaultValue)

Get the value of the configuration property with the given name in the configuration element with the given id. Return the given default value if no such configuration property or configuration element exists.

Parameters:

elementId - The configuration element id.

name - The configuration property name.

defaultValue - The default value (may be null)

Returns:

The value of the configuration property if it exists, or the default value otherwise.

Since:

0.8

removeConfigurationProperty

void removeConfigurationProperty(java.lang.String elementId,
                               java.lang.String name)

Removes the configuration property with the given name in the configuration element with the given id. The configuration element must already exist. Will do nothing if the property does not exist within the configuration element.

Parameters:

elementId - The configuration element id.

name - The configuration property name.

Since:

0.8

setConfigurationProperty

void setConfigurationProperty(java.lang.String elementId,
                            java.lang.String name,
                            java.lang.String value)

Set the value of the configuration property with the given name in the configuration element with the given id. Create the configuration property if it does not already exist. The configuration element must already exist.

Parameters:

elementId - The configuration element id.

name - The configuration property name.

value - The configuration property value.

Since:

0.8

copyDefinition

IBuildDefinition copyDefinition()

Make a copy of this definition.

Returns:

The new build definition. It is a working copy and has not been saved. The origin is not set. The new copy has a different UUID than the original. The new copy has a clear history. The remainder of the contents are equal to the original.

initializeConfiguration

void initializeConfiguration(IBuildConfigurationElement element)

Initialize the build definition from the given configuration element. The element is added to the definition after existing configuration elements. In addition, the generic properties declared in the element's extension are copied into the build definition.

If an element with the same id is already present in the definition, it is overwritten at its current position.

This method may be called more than once with different configuration elements.

Parameters:

element - The configuration element to initialize the definition with.

initializeConfiguration

void initializeConfiguration(IBuildDefinitionTemplate template)

Initialize the build definition from the given template. The configuration elements specified by the template are copied into the definition. In addition, the generic properties declared in the template's extension are copied into the build definition. Any existing elements in the definition are overwritten by template elements with the same id. Likewise, any existing generic properties will be overwritten by template properties with the same name.

This method may be called more than once with different templates.

Parameters:

template - The template to initialize the definition with.