com.ibm.team.workitem.common.model

Interface IDeliverable

All Superinterfaces:

IAuditable, IAuditableHandle, IDeliverableHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle, IProjectScoped

public interface IDeliverable
extends IDeliverableHandle, IAuditable, IProjectScoped

A deliverable represents a release like a milestone or final release. Deliverables are scoped to a project area.

Since:

0.6

See Also:

IWorkItem#FOUND_IN_PROPERTY}, com.ibm.team.workitem.common.IWorkItemCommon#findDeliverablesByProjectArea(IProjectAreaHandle, boolean, ItemProfile, org.eclipse.core.runtime.IProgressMonitor)}

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCHIVED_PROPERTY The archived property, see isArchived().
static java.lang.String	ARTIFACT_PROPERTY The artifact property, see getArtifact().
static java.lang.String	CREATION_DATE_PROPERTY The creation date property, see getCreationDate().
static ItemProfile<IDeliverable>	DEFAULT_PROFILE
static java.lang.String	DESCRIPTION_PROPERTY The description property, see getHTMLDescription().
static java.lang.String	FILTERED_PROPERTY The filtered property, see isFiltered().
static ItemProfile<IDeliverable>	FULL_PROFILE The full item profile.
static IItemType	ITEM_TYPE The deliverable item type.
static java.lang.String	ITERATION_PROPERTY The iteration property, see getIteration().
static ItemProfile<IDeliverable>	LARGE_PROFILE
static ItemProfile<IDeliverable>	MEDIUM_PROFILE
static java.lang.String	NAME_PROPERTY The name property, see getName().
static ItemProfile<IDeliverable>	PROJECT_AREA_PROFILE
static java.lang.String	PROJECT_AREA_PROPERTY The project area property, see getProjectArea().
static ItemProfile<IDeliverable>	SMALL_PROFILE

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
IItemHandle	getArtifact() Returns the associate artifact or null.
java.sql.Timestamp	getCreationDate() Returns the creation date or null.
com.ibm.team.foundation.common.text.XMLString	getHTMLDescription() Returns the description.
IIterationHandle	getIteration() Returns the iteration for the deliverable
java.lang.String	getName() Returns the name suitable for presenting it as part of a label to the user.
IProjectAreaHandle	getProjectArea() Returns the project area this deliverable belongs to.
boolean	isArchived() Returns true iff the deliverable is archived and should no longer be used.
boolean	isFiltered() Returns true iff the deliverable should be hidden from contributors not part of any project team.
void	setArchived(boolean value) Sets the archived flag to the given value.
void	setArtifact(IItemHandle value) Sets the associated artifact to the given.
void	setCreationDate(java.sql.Timestamp value) Sets the creation date to the given value.
void	setFiltered(boolean value) Sets the filter flag to the given value.
void	setHTMLDescription(com.ibm.team.foundation.common.text.XMLString value) Sets the description to the given xml string.
void	setIteration(IIterationHandle value) Sets the iteration to the given value.
void	setName(java.lang.String value) Sets the name to the given value.

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

PROJECT_AREA_PROPERTY

static final java.lang.String PROJECT_AREA_PROPERTY

The project area property, see getProjectArea().

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

The name property, see getName().

DESCRIPTION_PROPERTY

static final java.lang.String DESCRIPTION_PROPERTY

The description property, see getHTMLDescription().

CREATION_DATE_PROPERTY

static final java.lang.String CREATION_DATE_PROPERTY

The creation date property, see getCreationDate().

ARTIFACT_PROPERTY

static final java.lang.String ARTIFACT_PROPERTY

The artifact property, see getArtifact().

FILTERED_PROPERTY

static final java.lang.String FILTERED_PROPERTY

The filtered property, see isFiltered().

ARCHIVED_PROPERTY

static final java.lang.String ARCHIVED_PROPERTY

The archived property, see isArchived().

ITERATION_PROPERTY

static final java.lang.String ITERATION_PROPERTY

The iteration property, see getIteration().

SMALL_PROFILE

static final ItemProfile<IDeliverable> SMALL_PROFILE

DEFAULT_PROFILE

static final ItemProfile<IDeliverable> DEFAULT_PROFILE

MEDIUM_PROFILE

static final ItemProfile<IDeliverable> MEDIUM_PROFILE

LARGE_PROFILE

static final ItemProfile<IDeliverable> LARGE_PROFILE

PROJECT_AREA_PROFILE

static final ItemProfile<IDeliverable> PROJECT_AREA_PROFILE

FULL_PROFILE

static final ItemProfile<IDeliverable> FULL_PROFILE

The full item profile.

Method Detail

getProjectArea

IProjectAreaHandle getProjectArea()

Returns the project area this deliverable belongs to.

Specified by:

getProjectArea in interface IProjectScoped

Returns:

the project area

getName

java.lang.String getName()

Returns the name suitable for presenting it as part of a label to the user.

Returns:

the name

setName

void setName(java.lang.String value)

Sets the name to the given value.

Parameters:

value - the new name

getArtifact

IItemHandle getArtifact()

Returns the associate artifact or null.

Returns:

the associate artifact or null

setArtifact

void setArtifact(IItemHandle value)

Sets the associated artifact to the given.

Parameters:

value - the new artifact or null

isFiltered

boolean isFiltered()

Returns true iff the deliverable should be hidden from contributors not part of any project team.

Returns:

true iff the deliverable should be hidden from unaffiliated contributors

setFiltered

void setFiltered(boolean value)

Sets the filter flag to the given value.

Parameters:

value - the new value

isArchived

boolean isArchived()

Returns true iff the deliverable is archived and should no longer be used.

Returns:

true iff the deliverable is archived

setArchived

void setArchived(boolean value)

Sets the archived flag to the given value.

Parameters:

value - the new value

getCreationDate

java.sql.Timestamp getCreationDate()

Returns the creation date or null. The creation date refers to the point in time the release is made, not the creation time of this item.

Returns:

the creation date or null

setCreationDate

void setCreationDate(java.sql.Timestamp value)

Sets the creation date to the given value.

Parameters:

value - the creation date or null

getHTMLDescription

com.ibm.team.foundation.common.text.XMLString getHTMLDescription()

Returns the description.

Returns:

the description

setHTMLDescription

void setHTMLDescription(com.ibm.team.foundation.common.text.XMLString value)

Sets the description to the given xml string.

Parameters:

value - the new description

getIteration

IIterationHandle getIteration()

Returns the iteration for the deliverable

Returns:

the iteration

setIteration

void setIteration(IIterationHandle value)

Sets the iteration to the given value.

Parameters:

value - the new name