Package com.polarion.alm.builder.model

Interface IBuildArtifact

All Superinterfaces:

IAdaptable, IChangeListener, IHasCustomValues, IHasValues, IPObject

public interface IBuildArtifact
extends IPObject

Build artifact.

Smallest building/reporting entity.

Identification (group and artifact ids) is modelled after Maven 2's artifact identification.

Object id is unique within one getGroupEntity() and consists of getGroupId(), getArtifactId() and getRepositoryTag() (linked with colon ":").

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGGREGATION_RESOURCES	field aggregationResources of class Collection of ILocalDeploymentDefinitions
static final String	ARTIFACT_ID	field artifactId of class String
static final String	BASE_LOCATION	field baseLocation of class ILocation
static final String	BUILD_DEPENDENCIES	field buildDependencies of class Collection of IBuildArtifactSelectors
static final String	BUILD_DESCRIPTORS	field buildDescriptors of class Collection of IBuildDescriptor
static final String	CALCULATION_DESCRIPTORS	field calculationDescriptors of class Collection of ICalculationDescriptor
static final String	CONTAINED_ARTIFACTS	field containedArtifacts of class Collection of SubterraURIs
static final String	DESCRIPTION	field description of class String
static final String	GROUP_ENTITY	field groupEntity of class SubterraURI
static final String	GROUP_ID	field groupId of class String
static final String	LABEL	field label of class String
static final String	PROTO	prototype name
static final String	REPOSITORY_TAG	field repositoryTag of class String
static final String	RESOURCES	field resources of class Collection of ILocalDeploymentDefinitions
static final String	TYPE	field type of class String
static final String	TYPE_SPECIFIC_DATA	field typeSpecificData of class Collection of IStructures
static final String	TYPE_SPECIFIC_DATA_KEY
static final String	TYPE_SPECIFIC_DATA_VALUE

Method Summary

Modifier and Type	Method	Description
List	getAggregationResources()	Resources which are needed for reports aggregation (minimal set of resources).
String	getArtifactId()	Artifact id.
ILocation	getBaseLocation()	Base location for this build artifact.
List	getBuildDependencies()	Build dependencies (only direct, not transitional).
IBuildDescriptor	getBuildDescriptor(String name)	Build descriptor of given name (if any).
Collection	getBuildDescriptors()	Build descriptors applicable to this artifact.
ICalculationDescriptor	getCalculationDescriptor(String name)	Calculation descriptor of given name (if any).
Collection	getCalculationDescriptors()	Calculation descriptors applicable to this artifact.
ICalculationDescriptor	getCalculationDescriptorWithExtensions(String name)	Calculation descriptor of given name (if any) with all extensions expanded.
List	getContainedArtifacts()	All contained artifacts.
String	getDescription()	Arbitrary, human-readable description (if any).
IGroupEntity	getGroupEntity()	Associated IGroupEntity.
String	getGroupId()	Group id.
String	getLabel()	Human-readable build artifact label (short description).
String	getRepositoryTag()	Repository tag (if any).
List	getResources()	Resources which comprise this artifact.
String	getType()	Artifact type.
String	getTypeSpecificValue(String key)	Type specific data.

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

GROUP_ID

static final String GROUP_ID

field groupId of class String

See Also:

• Constant Field Values

ARTIFACT_ID

static final String ARTIFACT_ID

field artifactId of class String

See Also:

• Constant Field Values

REPOSITORY_TAG

static final String REPOSITORY_TAG

field repositoryTag of class String

See Also:

• Constant Field Values

TYPE

static final String TYPE

field type of class String

See Also:

• Constant Field Values

LABEL

static final String LABEL

field label of class String

See Also:

• Constant Field Values

DESCRIPTION

static final String DESCRIPTION

field description of class String

See Also:

• Constant Field Values

CONTAINED_ARTIFACTS

static final String CONTAINED_ARTIFACTS

field containedArtifacts of class Collection of SubterraURIs

See Also:

• Constant Field Values

GROUP_ENTITY

static final String GROUP_ENTITY

field groupEntity of class SubterraURI

See Also:

• Constant Field Values

BUILD_DESCRIPTORS

static final String BUILD_DESCRIPTORS

field buildDescriptors of class Collection of IBuildDescriptor

See Also:

• Constant Field Values

CALCULATION_DESCRIPTORS

static final String CALCULATION_DESCRIPTORS

field calculationDescriptors of class Collection of ICalculationDescriptor

See Also:

• Constant Field Values

BASE_LOCATION

static final String BASE_LOCATION

field baseLocation of class ILocation

See Also:

• Constant Field Values

RESOURCES

static final String RESOURCES

field resources of class Collection of ILocalDeploymentDefinitions

See Also:

• Constant Field Values

AGGREGATION_RESOURCES

static final String AGGREGATION_RESOURCES

field aggregationResources of class Collection of ILocalDeploymentDefinitions

See Also:

• Constant Field Values

BUILD_DEPENDENCIES

static final String BUILD_DEPENDENCIES

field buildDependencies of class Collection of IBuildArtifactSelectors

See Also:

• Constant Field Values

TYPE_SPECIFIC_DATA

static final String TYPE_SPECIFIC_DATA

field typeSpecificData of class Collection of IStructures

See Also:

• Constant Field Values

TYPE_SPECIFIC_DATA_KEY

static final String TYPE_SPECIFIC_DATA_KEY

See Also:

• Constant Field Values

TYPE_SPECIFIC_DATA_VALUE

static final String TYPE_SPECIFIC_DATA_VALUE

See Also:

• Constant Field Values

Method Details

getGroupId

String getGroupId()

Group id.

Required, never null.

Returns:

group id (not null)

getArtifactId

String getArtifactId()

Artifact id.

Required, never null.

Returns:

artifact id (not null)

getRepositoryTag

String getRepositoryTag()

Repository tag (if any).

Returns:

repository tag or null

getType

String getType()

Artifact type.

Returns:

artifact type (not null)

getLabel

String getLabel()

Human-readable build artifact label (short description).

Returns:

label (not null)

getDescription

String getDescription()

Arbitrary, human-readable description (if any).

Returns:

description or null

getContainedArtifacts

List getContainedArtifacts()

All contained artifacts.

Project groups contain subgroups and subprojects.

Returns:

List of IBuildArtifacts (not null)

getGroupEntity

IGroupEntity getGroupEntity()

Associated IGroupEntity.

IProjectGroup has only one artifact, IProject may have more.

Returns:

repository object (not null)

getBuildDescriptors

Collection getBuildDescriptors()

Build descriptors applicable to this artifact.

Returns:

Collection of IBuildDescriptors (not null)

getCalculationDescriptors

Collection getCalculationDescriptors()

Calculation descriptors applicable to this artifact.

Returns:

Collection of ICalculationDescriptors (not null)

getBuildDescriptor

IBuildDescriptor getBuildDescriptor(String name)

Build descriptor of given name (if any).

Parameters:

name - descriptor name

Returns:

build descriptor or null

Throws:

IllegalArgumentException - if name is null

getCalculationDescriptor

ICalculationDescriptor getCalculationDescriptor(String name)

Calculation descriptor of given name (if any).

Parameters:

name - descriptor name

Returns:

calculation descriptor or null

Throws:

IllegalArgumentException - if name is null

getCalculationDescriptorWithExtensions

ICalculationDescriptor getCalculationDescriptorWithExtensions(String name)

Calculation descriptor of given name (if any) with all extensions expanded.

Parameters:

name - descriptor name

Returns:

calculation descriptor or null

Throws:

IllegalArgumentException - if name is null

IllegalArgumentException - if extensions are of different type, have cycles or do not exist

getBaseLocation

ILocation getBaseLocation()

Base location for this build artifact.

Normally it is set to location of associated getGroupEntity(), but can be set to arbitrary location.

Base location should contain all resources for this artifact (no resources should be located in parent folders or in other unrelated folders).

May return null if and only if associated getGroupEntity() is not located in repository.

Returns:

base location or null in special case

getResources

List getResources()

Resources which comprise this artifact.

Returned locations are relative to getBaseLocation().

Is empty for project groups.

Returns:

List of ILocalDeploymentDefinitions (not null)

getAggregationResources

List getAggregationResources()

Resources which are needed for reports aggregation (minimal set of resources).

Returned locations are relative to getBaseLocation().

Is empty for project groups.

Returns:

List of ILocalDeploymentDefinitions (not null)

getBuildDependencies

List getBuildDependencies()

Build dependencies (only direct, not transitional).

All selector's fields are treated literally (no pattern matching).

Returns:

List of IBuildArtifactSelectors (not null)

getTypeSpecificValue

String getTypeSpecificValue(String key)

Type specific data.

Parameters:

key - data key

Returns:

value or null if key is not known

Throws:

IllegalArgumentException - if key is null