Package com.polarion.alm.builder.model

Interface IBuild

All Superinterfaces:

IAdaptable, IChangeListener, IHasCustomValues, IHasValues, IPObject

All Known Subinterfaces:

ITrackerBuild

public interface IBuild
extends IPObject

Build representation.

The object id is unique within one IBuildArtifact.getGroupEntity() and is equal to getBuildStamp().

Author:

Stepan Roh, Polarion Software

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHOR	field author of class SubterraURI
static final String	BIR_LOCATION	field birLocation of class ILocation
static final String	BUILD_ARTIFACT	field buildArtifact of class SubterraURI
static final String	BUILD_DESCRIPTOR_NAME	field buildDescriptorName of class String
static final String	BUILD_EVENTS	field buildEvents of class IBuildEvents
static final String	BUILD_REQUESTOR_SPECIFIC_DATA	field buildRequestorSpecificData of class Collection of IStructures
static final String	BUILD_STAMP	field buildStamp of class String
static final String	BUILD_STATUS	field buildStatus of class IBuildStatus
static final String	BUILD_TAG	field buildTag of class String
static final String	BUILD_TEST_RESULTS	field buildEvents of class IBuildTestResults
static final String	CALCULATION_DESCRIPTOR_NAME	field calculationDescriptorName of class String
static final String	CREATION_TIME	field creationTime of class Date
static final String	DEPLOYED_ARTIFACTS	field deployedArtifacts of class Collection of IBuildDeploymentArtifacts
static final String	FINISH_TIME	field finishTime of class Date
static final String	JOB_ID
static final String	LOCAL_DEPLOYMENT_SPACE_NAME	field localDeploymentSpaceName of class String
static final String	LOG_FILES	field logFiles of class Collection of ILocations
static final String	PROTO	prototype name
static final String	REPORT_LOCATION	field reportLocation of class ILocation
static final String	START_TIME	field startTime of class Date

Method Summary

Modifier and Type	Method	Description
IUser	getAuthor()	The user who runs this build/calculation.
ILocation	getBIRLocation()	Folder in IBuilderService.getBuildInformationRepository().
IBuildArtifact	getBuildArtifact()	Build artifact.
String	getBuildDescriptorName()	Build descriptor name.
IBuildEvents	getBuildEvents()	Gathered build events.
String	getBuildRequestorSpecificDataValue(String key)	Build Requestor specific data.
String	getBuildStamp()	Build timestamp.
IBuildStatus	getBuildStatus()	Build status.
String	getBuildTag()	Build tag.
IBuildTestResults	getBuildTestResults()	Test results, filled in after the build has finished.
String	getCalculationDescriptorName()	Calculation descriptor name.
Date	getCreationTime()	The build job creation time.
Collection<IBuildDeploymentArtifact>	getDeployedArtifacts()	Information about artifacts deployed to BIR during the build.
String	getDurationAsString()	The actual build duration time.
Date	getFinishTime()	The build finish time.
String	getJobId()	Returns the ID of a master job associated with the build.
String	getLocalDeploymentSpaceName()	The name of the local deployment space.
Collection<ILocation>	getLogFiles()	All available log files associated with this build are stored in the IBuilderService.getBuildInformationRepository().
Date	getStartTime()	The build start time.

Methods inherited from interface com.polarion.platform.persistence.model.IAdaptable

adapt

Methods inherited from interface com.polarion.platform.persistence.model.IChangeListener

markChanged

Methods inherited from interface com.polarion.platform.persistence.model.IHasCustomValues

getCustomField, getCustomFieldPrototype, getCustomFieldsList, setCustomField

Methods inherited from interface com.polarion.platform.persistence.model.IPObject

can, copyTo, createStructureForKey, forget, getContextId, getDataRevision, getDataSvc, getEnumerationOptionForField, getEnumerationTypeForField, getFieldLabel, getFieldType, getIncompatibleCustomField, getIncompatibleCustomFieldPrototype, getIncompatibleCustomFieldsList, getLastRevision, getLocalId, getObjectId, getPrototype, getRevision, getUri, getValue, isModified, isPersisted, isReadOnly, isResolved, isUnresolvable, resolve, save, setEnumerationValue, setValue, update

Field Details

PROTO

static final String PROTO

prototype name

See Also:

• Constant Field Values

AUTHOR

static final String AUTHOR

field author of class SubterraURI

See Also:

• Constant Field Values

BUILD_ARTIFACT

static final String BUILD_ARTIFACT

field buildArtifact of class SubterraURI

See Also:

• Constant Field Values

BUILD_DESCRIPTOR_NAME

static final String BUILD_DESCRIPTOR_NAME

field buildDescriptorName of class String

See Also:

• Constant Field Values

CALCULATION_DESCRIPTOR_NAME

static final String CALCULATION_DESCRIPTOR_NAME

field calculationDescriptorName of class String

See Also:

• Constant Field Values

BUILD_TAG

static final String BUILD_TAG

field buildTag of class String

See Also:

• Constant Field Values

LOCAL_DEPLOYMENT_SPACE_NAME

static final String LOCAL_DEPLOYMENT_SPACE_NAME

field localDeploymentSpaceName of class String

See Also:

• Constant Field Values

BUILD_STAMP

static final String BUILD_STAMP

field buildStamp of class String

See Also:

• Constant Field Values

BIR_LOCATION

static final String BIR_LOCATION

field birLocation of class ILocation

See Also:

• Constant Field Values

CREATION_TIME

static final String CREATION_TIME

field creationTime of class Date

See Also:

• Constant Field Values

START_TIME

static final String START_TIME

field startTime of class Date

See Also:

• Constant Field Values

FINISH_TIME

static final String FINISH_TIME

field finishTime of class Date

See Also:

• Constant Field Values

BUILD_STATUS

static final String BUILD_STATUS

field buildStatus of class IBuildStatus

See Also:

• Constant Field Values

REPORT_LOCATION

static final String REPORT_LOCATION

field reportLocation of class ILocation

See Also:

• Constant Field Values

LOG_FILES

static final String LOG_FILES

field logFiles of class Collection of ILocations

See Also:

• Constant Field Values

BUILD_EVENTS

static final String BUILD_EVENTS

field buildEvents of class IBuildEvents

See Also:

• Constant Field Values

DEPLOYED_ARTIFACTS

static final String DEPLOYED_ARTIFACTS

field deployedArtifacts of class Collection of IBuildDeploymentArtifacts

See Also:

• Constant Field Values

BUILD_TEST_RESULTS

static final String BUILD_TEST_RESULTS

field buildEvents of class IBuildTestResults

See Also:

• Constant Field Values

JOB_ID

static final String JOB_ID

Since:

3.7.3

See Also:

• Constant Field Values

BUILD_REQUESTOR_SPECIFIC_DATA

static final String BUILD_REQUESTOR_SPECIFIC_DATA

field buildRequestorSpecificData of class Collection of IStructures

Since:

3.20.2

See Also:

• Constant Field Values

Method Details

getAuthor

IUser getAuthor()

The user who runs this build/calculation.

More specifically this is the user whose Subject was used when the master build/calculation job was spawned.

If there is no Polarion user corresponding to the caller, the default or synthetic user is supplied.

Returns:

user (not null)

getBuildArtifact

IBuildArtifact getBuildArtifact()

Build artifact.

Taken from IBuilderService.runBuild(IBuildArtifact, String, String, String, String, Properties) (through master job).

Returns:

build artifact (not null)

getBuildDescriptorName

String getBuildDescriptorName()

Build descriptor name.

Taken from IBuilderService.runBuild(IBuildArtifact, String, String, String, String, Properties) (through master job).

Returns:

build descriptor name or null

getCalculationDescriptorName

String getCalculationDescriptorName()

Calculation descriptor name.

Taken from IBuilderService.runBuild(IBuildArtifact, String, String, String, String, Properties) (through master job).

Returns:

calculation descriptor name or null

getBuildTag

String getBuildTag()

Build tag.

Taken from IBuilderService.runBuild(IBuildArtifact, String, String, String, String, Properties) (through master job).

Returns:

build tag (not null)

getLocalDeploymentSpaceName

String getLocalDeploymentSpaceName()

The name of the local deployment space.

Taken from IBuilderService.runBuild(IBuildArtifact, String, String, String, String, Properties) (through master job).

Returns:

the name of the local deployment space or null

getBuildStamp

String getBuildStamp()

Build timestamp.

Returns:

build timestamp (not null)

getBIRLocation

ILocation getBIRLocation()

Folder in IBuilderService.getBuildInformationRepository().

Will return the same value as IBuildInformationRepository.getProjectBuildLocation(IBuildArtifact, String) or null.

Will return null if this represents a reports calculation.

Returns:

folder location or null

getCreationTime

Date getCreationTime()

The build job creation time.

Returns:

start time (not null)

See Also:

• IJob.getCreationTime()

getStartTime

Date getStartTime()

The build start time.

Returns:

start time (not null)

See Also:

• IJob.getStartTime()

getFinishTime

Date getFinishTime()

The build finish time.

Returns:

finish time or null

See Also:

• IJob.getFinishTime()

getDurationAsString

String getDurationAsString()

The actual build duration time.

Returns:

The actual duration time

Since:

3.5.2

getBuildStatus

IBuildStatus getBuildStatus()

Build status.

Returns:

status (not null)

getLogFiles

Collection<ILocation> getLogFiles()

All available log files associated with this build are stored in the IBuilderService.getBuildInformationRepository().

This will typically only be available after the build is finished and log files are transferred to BIR.

It is possible that the returned log files do not yet exist at the time of the call.

For a list of log files available during whole job lifecycle see the following method. ILogger.getLogFiles() of interface ILogger retrievable from IJobUnit.getLogger() of associated IJob. Note that these two sets of log files may be different. (There may be additional log files available from one or the other).

As long as the job is associated with this build, use ILogger.getLogEvents() instead of the log files (either retrieved from the job or from this method).

Locations are relative to getBIRLocation().

Returns:

Collection of ILocations (not null)

getBuildEvents

@NotNull
IBuildEvents getBuildEvents()

Gathered build events.

Typically based on the log (but filtered to contain only normal and fatal errors). The returned value should not be modified by clients outside of the builds framework.

Returns:

IBuildEvents (not null)

getDeployedArtifacts

Collection<IBuildDeploymentArtifact> getDeployedArtifacts()

Information about artifacts deployed to BIR during the build.

Is empty for plain calculations. Is filled in after the build has finished.

Returns:

Collection of IBuildDeploymentArtifacts (not null)

getBuildTestResults

@Nullable
IBuildTestResults getBuildTestResults()

Test results, filled in after the build has finished.

Is null for plain calculations, or before the build has finished.

Returns:

IBuildTestResults or null

getJobId

String getJobId()

Returns the ID of a master job associated with the build.

Since:

3.7.3

getBuildRequestorSpecificDataValue

@Nullable
String getBuildRequestorSpecificDataValue(@NotNull
 String key)

Build Requestor specific data.

Parameters:

key - data key

Returns:

value or null

Since:

3.20.2