com.ibm.team.process.common

Interface IDevelopmentLine

All Superinterfaces:

IAuditable, IAuditableHandle, IDevelopmentLineHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle, INamed, IProcessItem, IProcessItemHandle

public interface IDevelopmentLine
extends IDevelopmentLineHandle, IProcessItem

A project area development line.

Since:

0.6

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENT_ITERATION_PROPERTY_ID Id of the current iteration property.
static java.lang.String	ID_PROPERTY_ID Id of the process data property.
static IItemType	ITEM_TYPE The development line item type.
static java.lang.String	ITERATIONS_PROPERTY_ID Id of the iterations property.
static java.lang.String	PROJECT_AREA_PROPERTY_ID Id of the project area property.

Fields inherited from interface com.ibm.team.process.common.IProcessItem

DESCRIPTION_DETAILS_PROPERTY_ID, DESCRIPTION_SUMMARY_PROPERTY_ID, DEVELOPMENT_LINE, ITERATION, ITERATION_TYPE, NAME_PROPERTY_ID, PROCESS_ATTACHMENT, PROCESS_DEFINITION, PROCESS_DOMAIN_DEFINITION, PROJECT_AREA, PROJECT_LINK, READ_ACCESS_LIST, TEAM_AREA

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
void	addIteration(IIterationHandle iteration) Adds the iteration identified by the given handle at the end of the list of children.
IIterationHandle	getCurrentIteration() Returns this development line's current iteration or null if this development line does not have a current iteration.
java.util.Date	getEndDate() Returns this development line's end date or null if no end date has been configured.
java.lang.String	getId() Returns this development line's identifier or null if no identifier has been set.
IIterationHandle[]	getIterations() Returns the top-level iterations contained in this development line.
java.lang.String	getLabel() This convenience method returns the name of this line if the name is not null and is not a whitespace string.
IProjectAreaHandle	getProjectArea() Returns the project area which contains this development line or null if no project area has been set.
java.util.Date	getStartDate() Returns this development line's start date or null if no start date has been configured.
void	insertIterationAfter(IIterationHandle iteration, IIterationHandle anchor) Adds the iteration identified by the given handle into the list of children right of the given anchor.
boolean	isArchived() Returns whether this development line is archived.
void	removeIteration(IIterationHandle iteration) Removes the iteration identified by the given handle from the list of iterations.
void	setCurrentIteration(IIterationHandle current) Sets this development line's current iteration.
void	setEndDate(java.util.Date date) Sets this development line's start date.
void	setId(java.lang.String id) Sets this development line's identifier.
void	setIterations(IIterationHandle[] iterations) Sets this development line's iterations.
void	setProjectArea(IProjectAreaHandle projectArea) Sets this development line's project area.
void	setStartDate(java.util.Date date) Sets this development line's start date.

Methods inherited from interface com.ibm.team.process.common.IProcessItem

getProcessItemType, getPropertyName

Methods inherited from interface com.ibm.team.process.common.INamed

getDescription, getName, setName

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 development line item type.

ID_PROPERTY_ID

static final java.lang.String ID_PROPERTY_ID

Id of the process data property.

See Also:

Constant Field Values

ITERATIONS_PROPERTY_ID

static final java.lang.String ITERATIONS_PROPERTY_ID

Id of the iterations property.

See Also:

Constant Field Values

CURRENT_ITERATION_PROPERTY_ID

static final java.lang.String CURRENT_ITERATION_PROPERTY_ID

Id of the current iteration property.

See Also:

Constant Field Values

PROJECT_AREA_PROPERTY_ID

static final java.lang.String PROJECT_AREA_PROPERTY_ID

Id of the project area property.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns this development line's identifier or null if no identifier has been set.

Development line ids are unique per project area.

In order for this item to be saved to the repository this field must have a non-null value, so it is safe to assume that this method will not return null if it is an immutable copy fetched from the repository. It is possible for an incomplete/invalid working copy, however, to return null.

Returns:

the development line's identifier or null

setId

void setId(java.lang.String id)

Sets this development line's identifier.

Parameters:

id - the new identifier

getLabel

java.lang.String getLabel()

This convenience method returns the name of this line if the name is not null and is not a whitespace string. Otherwise it returns this line's id, which may be null if this item is a working copy (@see getId().

Returns:

the name or id of this development line or null

getProjectArea

IProjectAreaHandle getProjectArea()

Returns the project area which contains this development line or null if no project area has been set.

In order for this item to be saved to the repository this field must have a non-null value, so it is safe to assume that this method will not return null if it is an immutable copy fetched from the repository. It is possible for an incomplete/invalid working copy, however, to return null.

Returns:

the project area which contains this development line

setProjectArea

void setProjectArea(IProjectAreaHandle projectArea)

Sets this development line's project area. In order to complete the bi-directional relationship, callers must also add this development line to the project area.

Parameters:

projectArea - the handle of the project area

getIterations

IIterationHandle[] getIterations()

Returns the top-level iterations contained in this development line.

Returns:

the top-level iterations contained in this development line

setIterations

void setIterations(IIterationHandle[] iterations)

Sets this development line's iterations. In order to complete the bi-directional relationship, callers must also set this development line on the given iterations.

insertIterationAfter

void insertIterationAfter(IIterationHandle iteration,
                        IIterationHandle anchor)

Adds the iteration identified by the given handle into the list of children right of the given anchor. In order to complete the bi-directional relationship, callers must also set this development line on the given iteration. If the given iteration is already an iteration of this development line, this method does not have any effect. If the anchor is null the iteration is added at the beginning of the list.

Parameters:

iteration - a handle for the iteration

anchor - the anchor after which to insert the iteration or null

addIteration

void addIteration(IIterationHandle iteration)

Adds the iteration identified by the given handle at the end of the list of children. In order to complete the bi-directional relationship, callers must also set this development line on the given iteration. If the given iteration is already an iteration of this development line, this method does not have any effect.

Parameters:

iteration - a handle for the iteration

removeIteration

void removeIteration(IIterationHandle iteration)

Removes the iteration identified by the given handle from the list of iterations. If the iteration does not belong to this development line, this method does not have any effect. In order to ensure the consistency of the bi-directional relationship, the caller has also to remove the development line from the iteration.

Parameters:

iteration - a handle to the iteration

getCurrentIteration

IIterationHandle getCurrentIteration()

Returns this development line's current iteration or null if this development line does not have a current iteration.

Returns:

this development line's current iteration

setCurrentIteration

void setCurrentIteration(IIterationHandle current)

Sets this development line's current iteration. The given iteration must be one of this development line's top-level iterations.

isArchived

boolean isArchived()

Returns whether this development line is archived.

Returns:

whether this development line is archived

getStartDate

java.util.Date getStartDate()

Returns this development line's start date or null if no start date has been configured.

Returns:

this development line's start date or null

Since:

0.7

setStartDate

void setStartDate(java.util.Date date)

Sets this development line's start date. If this development line has an end date set, the given date must be non-null and must come before the end date.

Parameters:

date - the start date or null

Since:

0.7

getEndDate

java.util.Date getEndDate()

Returns this development line's end date or null if no end date has been configured.

Returns:

this development line's end date or null

Since:

0.7

setEndDate

void setEndDate(java.util.Date date)

Sets this development line's start date. If specifying a non-null end date, this development line must have a start date set which comes before the end date.

Parameters:

date - the end date or null

Since:

0.7