com.ibm.team.build.common.model

Interface IBuildRequest

All Superinterfaces:

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

public interface IBuildRequest
extends IBuildRequestHandle, IAuditable, IBuildItem

Represents a request to perform an action on a build result or build definition.

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_ACTION The name of the build action property.
static java.lang.String	PROPERTY_BUILD_DEFINITION_INSTANCE The name of the build definition instances property.
static java.lang.String	PROPERTY_BUILD_RESULT The name of the build result property.
static java.lang.String	PROPERTY_CREATED The name of the created property.
static java.lang.String	PROPERTY_HANDLER The name of the handler property.
static java.lang.String	PROPERTY_HANDLING_CONTRIBUTOR The name of the handling contributor property.
static java.lang.String	PROPERTY_INITIATING_CONTRIBUTOR The name of the initiating contributor property.
static java.lang.String	PROPERTY_POTENTIAL_HANDLERS Deprecated. Potential handlers are now computed at the moment of request retrieval rather than at the moment of request. This will be eliminated as part of work item 45604.
static java.lang.String	PROPERTY_PROCESSED The name of the processed 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
IBuildAction	getBuildAction() Retrieves the build action indicating the action that should occur for this request.
IBuildDefinitionInstance	getBuildDefinitionInstance() Retrieves the snapshot of a build definition at the moment the build request is made to preserve the state of that build definition to be used when the request is processed.
java.util.Map	getBuildDefinitionProperties() Get a copy of the build definition properties from the request's build definition instance.
IBuildResultHandle	getBuildResult() Retrieves the build result handle associated with this build request.
java.sql.Timestamp	getCreated() Retrieves the time the request was made.
long	getCreatedMilliseconds() Deprecated. Use getCreated() instead.
IBuildEngineHandle	getHandler() Retrieves the service that picked up, processed and handled the build request.
IContributorHandle	getHandlingContributor() Retrieves the handle of the contributor that initiated the process to fulfill the build request.
IContributorHandle	getInitiatingContributor() Retrieves the handle of the contributor that initiated the build request.
java.util.List<IBuildEngineHandle>	getPotentialHandlers() Returns the handles of build engines that may handle this request.
boolean	isProcessed() Indicates if the build request has been processed or not.
void	setBuildAction(IBuildAction action) Sets the build action indicating the action that should occur for this request.
void	setBuildDefinitionInstance(IBuildDefinitionInstance buildDefinitionInstance) Sets the snapshot of a build definition at the moment the build request is made to preserve the state of that build definition to be used when the request is processed.
void	setBuildResult(IBuildResultHandle buildResultHandle) Sets the build result associated with this build request.
void	setCreated(java.sql.Timestamp creationTime) Sets the time the request was made.
void	setHandler(IBuildEngineHandle buildEngineHandle) Sets the service that picked up, processed and handled the build request.
void	setHandlingContributor(IContributorHandle contributorHandle) Sets the handle of the contributor that initiated the the process to fulfill the build request.
void	setInitiatingContributor(IContributorHandle contributorHandle) Sets the handle of the contributor that initiated the build request.
void	setProcessed(boolean processed) Sets the flag indicating if the build request has been processed.

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_ACTION

static final java.lang.String PROPERTY_BUILD_ACTION

The name of the build action property.

PROPERTY_BUILD_RESULT

static final java.lang.String PROPERTY_BUILD_RESULT

The name of the build result property.

PROPERTY_BUILD_DEFINITION_INSTANCE

static final java.lang.String PROPERTY_BUILD_DEFINITION_INSTANCE

The name of the build definition instances property.

PROPERTY_CREATED

static final java.lang.String PROPERTY_CREATED

The name of the created property.

PROPERTY_HANDLER

static final java.lang.String PROPERTY_HANDLER

The name of the handler property.

PROPERTY_HANDLING_CONTRIBUTOR

static final java.lang.String PROPERTY_HANDLING_CONTRIBUTOR

The name of the handling contributor property.

PROPERTY_INITIATING_CONTRIBUTOR

static final java.lang.String PROPERTY_INITIATING_CONTRIBUTOR

The name of the initiating contributor property.

PROPERTY_POTENTIAL_HANDLERS

static final java.lang.String PROPERTY_POTENTIAL_HANDLERS

Deprecated. Potential handlers are now computed at the moment of request retrieval rather than at the moment of request. This will be eliminated as part of work item 45604.

The name of the potential handlers property.

PROPERTY_PROCESSED

static final java.lang.String PROPERTY_PROCESSED

The name of the processed property.

Method Detail

isProcessed

boolean isProcessed()

Indicates if the build request has been processed or not.

Returns:

true if the build request has been processed.

setProcessed

void setProcessed(boolean processed)

Sets the flag indicating if the build request has been processed.

Parameters:

processed - flag indicating if the build request has been processed.

getBuildAction

IBuildAction getBuildAction()

Retrieves the build action indicating the action that should occur for this request.

Returns:

The build action indicating the action that should occur for this request.

setBuildAction

void setBuildAction(IBuildAction action)

Sets the build action indicating the action that should occur for this request.

Parameters:

action - The action that should occur for this request.

getBuildDefinitionInstance

IBuildDefinitionInstance getBuildDefinitionInstance()

Retrieves the snapshot of a build definition at the moment the build request is made to preserve the state of that build definition to be used when the request is processed.

Returns:

The snapshot of a build definition at the moment the build request is made.

setBuildDefinitionInstance

void setBuildDefinitionInstance(IBuildDefinitionInstance buildDefinitionInstance)

Sets the snapshot of a build definition at the moment the build request is made to preserve the state of that build definition to be used when the request is processed.

Parameters:

buildDefinitionInstance - The snapshot of a build definition at the moment the build request is made.

setBuildResult

void setBuildResult(IBuildResultHandle buildResultHandle)

Sets the build result associated with this build request.

Parameters:

buildResultHandle - The build result associated with this build request.

getBuildResult

IBuildResultHandle getBuildResult()

Retrieves the build result handle associated with this build request.

Returns:

The build result handle associated with this build request.

getInitiatingContributor

IContributorHandle getInitiatingContributor()

Retrieves the handle of the contributor that initiated the build request.

Returns:

The handle of the contributor that initiated the build request.

setInitiatingContributor

void setInitiatingContributor(IContributorHandle contributorHandle)

Sets the handle of the contributor that initiated the build request.

Parameters:

contributorHandle - The handle of the contributor that initiated the build request.

getHandlingContributor

IContributorHandle getHandlingContributor()

Retrieves the handle of the contributor that initiated the process to fulfill the build request.

Returns:

The handle of the contributor that initiated the build request.

setHandlingContributor

void setHandlingContributor(IContributorHandle contributorHandle)

Sets the handle of the contributor that initiated the the process to fulfill the build request.

Parameters:

contributorHandle - The handle of the contributor that initiated the process to fulfill the build request.

getHandler

IBuildEngineHandle getHandler()

Retrieves the service that picked up, processed and handled the build request.

Returns:

The service that picked up, processed and handled the build request.

setHandler

void setHandler(IBuildEngineHandle buildEngineHandle)

Sets the service that picked up, processed and handled the build request.

Parameters:

buildEngineHandle - The service that picked up, processed and handled the build request.

getCreated

java.sql.Timestamp getCreated()

Retrieves the time the request was made. It's used to support ordering the requests in the queue.

Returns:

The time the request was made.

getCreatedMilliseconds

long getCreatedMilliseconds()

Deprecated. Use getCreated() instead.

Retrieves the time the request was made as the number of milliseconds since Jan 1, 1970 GMT. It's used to support ordering the requests in the queue. This is a workaround for bug 7021, which keeps us from using getCreated() on the client.

Returns:

The time the request was made.

setCreated

void setCreated(java.sql.Timestamp creationTime)

Sets the time the request was made. It's used to support ordering the requests in the queue.

Parameters:

creationTime - The time the request was made.

getBuildDefinitionProperties

java.util.Map getBuildDefinitionProperties()

Get a copy of the build definition properties from the request's build definition instance.

Returns:

A map of the property names and values. The map keys are the property names (type String). The map values are the property values (type String). The returned map will be empty if there are no build definition properties. The returned map will be null if the buildDefinitionInstance was not fetched as part of this item.

getPotentialHandlers

java.util.List<IBuildEngineHandle> getPotentialHandlers()

Returns the handles of build engines that may handle this request. If empty, the engines supporting the build definition are used.

Returns:

The handles of build engines that may handle this request.

Since:

0.8