com.ibm.team.process.common

Interface IIteration

All Superinterfaces:

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

public interface IIteration
extends IIterationHandle, IProcessItem

An iteration in a project area. Each of the development lines in a project area can contain an arbitrary hierarchy of iterations.

Since:

0.6

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCHIVED_PROPERTY_ID Id of the archived property.
static java.lang.String	CHILDREN_ID Deprecated. use CHILDREN_PROPERTY_ID instead
static java.lang.String	CHILDREN_PROPERTY_ID Id of the children property.
static java.lang.String	DEVELOPMENT_LINE_ID Deprecated. use DEVELOPMENT_LINE_PROPERTY_ID instead
static java.lang.String	DEVELOPMENT_LINE_PROPERTY_ID Id of the development line property.
static java.lang.String	END_DATE_ID Deprecated. use END_DATE_PROPERTY_ID instead
static java.lang.String	END_DATE_PROPERTY_ID Id of the end date property.
static java.lang.String	HAS_DELIVERABLE_PROPERTY_ID Id of the hasDeliverable property.
static java.lang.String	ID_PROPERTY_ID Id of the id property.
static IItemType	ITEM_TYPE The iteration item type.
static java.lang.String	PARENT_ID Deprecated. use PARENT_PROPERTY_ID instead
static java.lang.String	PARENT_PROPERTY_ID Id of the parent property.
static java.lang.String	START_DATE_ID Deprecated. use START_DATE_PROPERTY_ID instead
static java.lang.String	START_DATE_PROPERTY_ID Id of the start date 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	addChild(IIterationHandle child) Adds the iteration identified by the given handle at the end of the list of child iterations.
IIterationHandle[]	getChildren() Returns the iterations into which this iteration is divided.
IDevelopmentLineHandle	getDevelopmentLine() Returns the development line to which this iteration belongs or null if no development line has been set.
java.util.Date	getEndDate() Returns this iteration's end date or null if no end date has been configured.
java.lang.String	getId() Returns the id of this iteration or null if no id has been set.
IIterationTypeHandle	getIterationType() Returns the type of this iteration or null if no type has been specified.
java.lang.String	getLabel() This convenience method returns the name of this iteration if the name is not null and is not a whitespace string.
IIterationHandle	getParent() Returns the parent iteration of this iteration or null if this iteration does not have a parent.
java.util.Date	getStartDate() Returns this iteration's start date or null if no start date has been configured.
boolean	hasDeliverable() Returns whether or not this iteration is configured as having a deliverable.
void	insertChildAfter(IIterationHandle child, IIterationHandle anchor) Inserts the iteration identified by the given handle into the list of child iterations right after the given anchor.
boolean	isArchived() Returns whether or not this iteration is archived.
void	removeChild(IIterationHandle child) Removes the iteration identified by the given handle from the list of child iterations.
void	setChildren(IIterationHandle[] children) Sets the child iterations of this iteration.
void	setDevelopmentLine(IDevelopmentLineHandle developmentLine) Returns the development line to which this iteration belongs.
void	setEndDate(java.util.Date date) Sets this iteration's end date.
void	setHasDeliverable(boolean hasDeliverable) Sets whether or not this iteration has a deliverable.
void	setId(java.lang.String identifier) Sets the id of this iteration.
void	setIterationType(IIterationTypeHandle handle) Sets the type of this iteration (may be null).
void	setParent(IIterationHandle parent) Set the parent iteration of this iteration.
void	setStartDate(java.util.Date date) Sets this iteration'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 iteration item type.

ID_PROPERTY_ID

static final java.lang.String ID_PROPERTY_ID

Id of the id property.

See Also:

Constant Field Values

ARCHIVED_PROPERTY_ID

static final java.lang.String ARCHIVED_PROPERTY_ID

Id of the archived property.

See Also:

Constant Field Values

START_DATE_PROPERTY_ID

static final java.lang.String START_DATE_PROPERTY_ID

Id of the start date property.

See Also:

Constant Field Values

START_DATE_ID

static final java.lang.String START_DATE_ID

Deprecated. use START_DATE_PROPERTY_ID instead

See Also:

Constant Field Values

END_DATE_PROPERTY_ID

static final java.lang.String END_DATE_PROPERTY_ID

Id of the end date property.

See Also:

Constant Field Values

END_DATE_ID

static final java.lang.String END_DATE_ID

Deprecated. use END_DATE_PROPERTY_ID instead

See Also:

Constant Field Values

DEVELOPMENT_LINE_PROPERTY_ID

static final java.lang.String DEVELOPMENT_LINE_PROPERTY_ID

Id of the development line property.

See Also:

Constant Field Values

DEVELOPMENT_LINE_ID

static final java.lang.String DEVELOPMENT_LINE_ID

Deprecated. use DEVELOPMENT_LINE_PROPERTY_ID instead

See Also:

Constant Field Values

CHILDREN_PROPERTY_ID

static final java.lang.String CHILDREN_PROPERTY_ID

Id of the children property.

See Also:

Constant Field Values

CHILDREN_ID

static final java.lang.String CHILDREN_ID

Deprecated. use CHILDREN_PROPERTY_ID instead

See Also:

Constant Field Values

PARENT_PROPERTY_ID

static final java.lang.String PARENT_PROPERTY_ID

Id of the parent property.

See Also:

Constant Field Values

PARENT_ID

static final java.lang.String PARENT_ID

Deprecated. use PARENT_PROPERTY_ID instead

See Also:

Constant Field Values

HAS_DELIVERABLE_PROPERTY_ID

static final java.lang.String HAS_DELIVERABLE_PROPERTY_ID

Id of the hasDeliverable property.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns the id of this iteration or null if no id 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 id of this iteration or null

setId

void setId(java.lang.String identifier)

Sets the id of this iteration. The provided identifier may not be null.

Parameters:

identifier - the new identifier, may not be null

getLabel

java.lang.String getLabel()

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

Returns:

the name or id of this iteration or null

getChildren

IIterationHandle[] getChildren()

Returns the iterations into which this iteration is divided. Returns an empty array if this iteration is undivided.

Returns:

the child iterations or an empty array

setChildren

void setChildren(IIterationHandle[] children)

Sets the child iterations of this iteration.

Note that in order to save the iteration, the child iterations will also have to declare this iteration as their parent. When establishing a new parent/child relationship, the parent/child iterations have to be saved together.

Parameters:

children - the child iterations

insertChildAfter

void insertChildAfter(IIterationHandle child,
                    IIterationHandle anchor)

Inserts the iteration identified by the given handle into the list of child iterations right after the given anchor. In order to complete the bi-directional relationship, callers must also set this iteration as parent of the new child. If the given iteration is already a child of this iteration, this method does not have any effect. If the anchor is null the element is added at the beginning of the list.

Parameters:

child - a handle for the new child

anchor - the current child after which the new child should be added or null

addChild

void addChild(IIterationHandle child)

Adds the iteration identified by the given handle at the end of the list of child iterations.

Note that in order to save the iteration, the child iteration will also have to declare this iteration as its parent. When establishing a new parent/child relationship, the parent/child iterations have to be saved together.

Parameters:

child - a handle for the new child

removeChild

void removeChild(IIterationHandle child)

Removes the iteration identified by the given handle from the list of child iterations. If the iteration is not a child of this iteration, 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 this iteration as parent from the given iteration.

Parameters:

child - a handle to the existing child

getParent

IIterationHandle getParent()

Returns the parent iteration of this iteration or null if this iteration does not have a parent. Iterations which do not have a parent are either root iterations (@see setDevelopmentLine(IDevelopmentLineHandle)) or they are misconfigured children (@see #setChildren()).

Returns:

the parent iteration or null

setParent

void setParent(IIterationHandle parent)

Set the parent iteration of this iteration. This will be null to indicate that the iteration is a root iteration.

Note that in order to save the iteration, the parent iteration will also have to contain this iteration as a child. If the parent is null, the development line will have to specify that it contains this root iteration. When establishing a new parent/child relationship, the parent/child iterations have to be saved together.

Parameters:

the - parent iteration

getDevelopmentLine

IDevelopmentLineHandle getDevelopmentLine()

Returns the development line to which this iteration belongs or null if no development line 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 development line to which this iteration belongs or null

setDevelopmentLine

void setDevelopmentLine(IDevelopmentLineHandle developmentLine)

Returns the development line to which this iteration belongs.

Note that in order to save the iteration, the development line will also have to contain this iteration (either directly or transitively). When adding a new iteration to a development line, the line, iteration, and any parent/child iterations have to be saved together.

Parameters:

the - development line

isArchived

boolean isArchived()

Returns whether or not this iteration is archived.

In order to archive an iteration, use the process client library or process server service.

Returns:

whether or not this iteration is archived

getStartDate

java.util.Date getStartDate()

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

Returns:

the iteration's start date or null

setStartDate

void setStartDate(java.util.Date date)

Sets this iteration's start date. If this iteration 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

getEndDate

java.util.Date getEndDate()

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

Returns:

the iteration's end date or null

setEndDate

void setEndDate(java.util.Date date)

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

Parameters:

date - the end date or null

hasDeliverable

boolean hasDeliverable()

Returns whether or not this iteration is configured as having a deliverable.

Returns:

whether or not this iteration is configured as having a deliverable

setHasDeliverable

void setHasDeliverable(boolean hasDeliverable)

Sets whether or not this iteration has a deliverable.

Parameters:

hasDeliverable - whether or not this iteration has a deliverable

getIterationType

IIterationTypeHandle getIterationType()

Returns the type of this iteration or null if no type has been specified.

Returns:

the type of this iteration or null

setIterationType

void setIterationType(IIterationTypeHandle handle)

Sets the type of this iteration (may be null).

Parameters:

handle - the type of this iteration or null