com.ibm.team.build.common.model

Interface IBuildResult

All Superinterfaces:

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

public interface IBuildResult
extends IBuildResultHandle, IAuditable, IBuildItem

The result of a build. A build result is typically created at the start of a build and used as a place to record status, logs, and other contributions as the build executes.

Since:

0.5

Field Summary

Fields

Modifier and Type	Field and Description
static IItemType	ITEM_TYPE The item type for this item.
static java.lang.String[]	PROPERTIES_VIEW_ITEM Just enough properties to display the IBuildResult as a node or item in a structured view.
static java.lang.String	PROPERTY_BUILD_ACTIVITIES The name of the build contributions property.
static java.lang.String	PROPERTY_BUILD_DEFINITION The name of the build definition property.
static java.lang.String	PROPERTY_BUILD_REQUESTS The name of the build requests property.
static java.lang.String	PROPERTY_BUILD_RESULT_CONTRIBUTIONS The name of the build contributions property.
static java.lang.String	PROPERTY_BUILD_START_TIME The name of the build start time property.
static java.lang.String	PROPERTY_BUILD_STATE The name of the build state property.
static java.lang.String	PROPERTY_BUILD_STATUS The name of the build status property.
static java.lang.String	PROPERTY_BUILD_TIME_TAKEN The name of the build time taken property.
static java.lang.String	PROPERTY_DELETE_ALLOWED The name of the delete allowed property.
static java.lang.String	PROPERTY_IGNORE_WARNINGS The name of the ignore warnings property.
static java.lang.String	PROPERTY_LABEL The name of the build label property.
static java.lang.String	PROPERTY_PERSONAL_BUILD The name of the personal build property.
static java.lang.String	PROPERTY_SUMMARY The name of the build summary property.
static java.lang.String	PROPERTY_TAGS The name of the activity count 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
IBuildDefinitionHandle	getBuildDefinition() Get the build definition for the result.
java.util.List	getBuildRequests() Retrieves all the build requests that processed an action against this build result.
long	getBuildStartTime() Get the time the build was started.
long	getBuildTimeTaken() Get the time taken by the build.
java.lang.String	getLabel() Retrieves the label of the build result.
java.lang.String[]	getParsedTags() Gets the tags field as an array of individual tags, rather than a single string of multiple tags.
BuildState	getState() Get the state of the build result.
BuildStatus	getStatus() Get the status of the build result.
java.lang.String	getTags() Retrieves the tags of the build result, as a comma-separated string.
boolean	isDeleteAllowed() Indicates if deletion of the build result is allowed.
boolean	isIgnoreWarnings() Determines if warnings will be ignored when computing the overall status of this build.
boolean	isInSameBuildState(IBuildResult buildResult) Determines if the build result is in the same build state as the specified build result.
boolean	isPersonalBuild() Indicates if the build result is from a personal build.
void	setBuildDefinition(IBuildDefinitionHandle buildDefinitionHandle) Set the build definition for the build.
void	setBuildStartTime(long startTime) Set the start time of the build.
void	setBuildTimeTaken(long value) Set the time taken by the build.
void	setDeleteAllowed(boolean deleteAllowed) Sets if deletion of the build result is allowed.
void	setIgnoreWarnings(boolean ignoreWarnings) Set whether or not warnings should be ignored when computing the overall status of this build.
void	setLabel(java.lang.String label) Set the label for the build result.
void	setPersonalBuild(boolean personalBuild) Sets whether or not the build result is from a personal build.
void	setStatus(BuildStatus status) Set the build status.
void	setTags(java.lang.String tags) Set the tags for the build result.

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 item.

PROPERTY_BUILD_REQUESTS

static final java.lang.String PROPERTY_BUILD_REQUESTS

The name of the build requests property.

PROPERTY_BUILD_RESULT_CONTRIBUTIONS

static final java.lang.String PROPERTY_BUILD_RESULT_CONTRIBUTIONS

The name of the build contributions property.

PROPERTY_BUILD_ACTIVITIES

static final java.lang.String PROPERTY_BUILD_ACTIVITIES

The name of the build contributions property.

PROPERTY_BUILD_START_TIME

static final java.lang.String PROPERTY_BUILD_START_TIME

The name of the build start time property.

PROPERTY_BUILD_TIME_TAKEN

static final java.lang.String PROPERTY_BUILD_TIME_TAKEN

The name of the build time taken property.

PROPERTY_BUILD_DEFINITION

static final java.lang.String PROPERTY_BUILD_DEFINITION

The name of the build definition property.

PROPERTY_LABEL

static final java.lang.String PROPERTY_LABEL

The name of the build label property.

PROPERTY_BUILD_STATE

static final java.lang.String PROPERTY_BUILD_STATE

The name of the build state property.

PROPERTY_BUILD_STATUS

static final java.lang.String PROPERTY_BUILD_STATUS

The name of the build status property.

PROPERTY_SUMMARY

static final java.lang.String PROPERTY_SUMMARY

The name of the build summary property.

PROPERTY_IGNORE_WARNINGS

static final java.lang.String PROPERTY_IGNORE_WARNINGS

The name of the ignore warnings property.

PROPERTY_TAGS

static final java.lang.String PROPERTY_TAGS

The name of the activity count property.

PROPERTY_DELETE_ALLOWED

static final java.lang.String PROPERTY_DELETE_ALLOWED

The name of the delete allowed property.

PROPERTY_PERSONAL_BUILD

static final java.lang.String PROPERTY_PERSONAL_BUILD

The name of the personal build property.

PROPERTIES_VIEW_ITEM

static final java.lang.String[] PROPERTIES_VIEW_ITEM

Just enough properties to display the IBuildResult as a node or item in a structured view.

Method Detail

getLabel

java.lang.String getLabel()

Retrieves the label of the build result.

Returns:

the label of the build result.

setLabel

void setLabel(java.lang.String label)

Set the label for the build result.

Parameters:

label - the label of the build result.

getBuildDefinition

IBuildDefinitionHandle getBuildDefinition()

Get the build definition for the result.

Returns:

The build definition for the result.

setBuildStartTime

void setBuildStartTime(long startTime)

Set the start time of the build.

Parameters:

startTime - The start time in milliseconds.

setBuildDefinition

void setBuildDefinition(IBuildDefinitionHandle buildDefinitionHandle)

Set the build definition for the build.

Parameters:

buildDefinitionHandle - The build definition.

getStatus

BuildStatus getStatus()

Get the status of the build result.

Returns:

The build result status.

getState

BuildState getState()

Get the state of the build result.

Returns:

the build result state.

getBuildTimeTaken

long getBuildTimeTaken()

Get the time taken by the build.

Returns:

the time taken, in milliseconds

setStatus

void setStatus(BuildStatus status)

Set the build status. Status cannot be set to a less severe status than its current value. For example, if the status is currently BuildStatus.ERROR, it cannot be set to BuildStatus.OK. When a result is created, its status is initialized to BuildStatus.OK. Throughout a build, as contributions are added to a result, the result's status may be updated to a more severe status, but not a less severe status.

Parameters:

status - The build result status.

setBuildTimeTaken

void setBuildTimeTaken(long value)

Set the time taken by the build.

Parameters:

value - the time taken, in milliseconds.

isInSameBuildState

boolean isInSameBuildState(IBuildResult buildResult)

Determines if the build result is in the same build state as the specified build result.

Parameters:

buildResult - The build result of interest to compare against.

Returns:

true If the two build results are in the same build state.

getBuildRequests

java.util.List getBuildRequests()

Retrieves all the build requests that processed an action against this build result.

Returns:

All the build requests that processed an action against this build result. The elements in the list are type IBuildRequestHandle.

getBuildStartTime

long getBuildStartTime()

Get the time the build was started.

Returns:

The time the build was started.

isIgnoreWarnings

boolean isIgnoreWarnings()

Determines if warnings will be ignored when computing the overall status of this build.

Returns:

Whether or not warnings will be ignored when computing the overall status of this build.

setIgnoreWarnings

void setIgnoreWarnings(boolean ignoreWarnings)

Set whether or not warnings should be ignored when computing the overall status of this build.

Parameters:

ignoreWarnings -

getTags

java.lang.String getTags()

Retrieves the tags of the build result, as a comma-separated string.

Returns:

the tags of the build result.

setTags

void setTags(java.lang.String tags)

Set the tags for the build result. When the build result is saved, this will be coerced into a string of lower-case keywords separated by commas.

Parameters:

tags - the tags of the build result.

isDeleteAllowed

boolean isDeleteAllowed()

Indicates if deletion of the build result is allowed.

Returns:

true if deletion of the build result is allowed.

setDeleteAllowed

void setDeleteAllowed(boolean deleteAllowed)

Sets if deletion of the build result is allowed.

Parameters:

deleteAllowed - true if deletion of the build result is allowed.

getParsedTags

java.lang.String[] getParsedTags()

Gets the tags field as an array of individual tags, rather than a single string of multiple tags.

Returns:

Array of String "tags"; array will be empty if this build result has not been tagged.

isPersonalBuild

boolean isPersonalBuild()

Indicates if the build result is from a personal build.

Returns:

true if the build result is from a personal build.

setPersonalBuild

void setPersonalBuild(boolean personalBuild)

Sets whether or not the build result is from a personal build.

Parameters:

personalBuild - true if the build result is from a personal build.