com.versionone.om

Class Iteration

java.lang.Object

com.versionone.om.Entity

com.versionone.om.BaseAsset

com.versionone.om.Iteration

public class Iteration
extends BaseAsset

Represents an iteration or sprint in the VersionOne System.

Field Summary

Fields inherited from class com.versionone.om.BaseAsset

STATE_ACTIVE, STATE_CLOSED

Fields inherited from class com.versionone.om.Entity

ASSET_STATE_VALUE, ASSET_VALUE, CHANGE_DATE_UTC, CONTENT_TYPE_VALUE, CONTENT_VALUE, CREATE_DATE_UTC, DELETE_OPERATION, DESCRIPTION_VALUE, FILENAME_VALUE, NAME_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Open or activate this iteration.
boolean	canActivate()
boolean	canMakeFuture()
DB.DateTime	getBeginDate()
Collection<Effort>	getEffortRecords(EffortFilter filter)
DB.DateTime	getEndDate()
Collection<PrimaryWorkitem>	getPrimaryWorkitems(PrimaryWorkitemFilter filter)
Schedule	getSchedule()
Double	getTotalDetailEstimate(WorkitemFilter filter)
Double	getTotalDone(WorkitemFilter filter)
Double	getTotalEstimate(PrimaryWorkitemFilter filter)
Double	getTotalToDo(WorkitemFilter filter)
boolean	isFuture()
void	makeFuture() Mark this iteration as future.
void	setBeginDate(DB.DateTime value)
void	setEndDate(DB.DateTime value)
void	setSchedule(Schedule value)

Methods inherited from class com.versionone.om.BaseAsset

canClose, canDelete, canReactivate, close, createAttachment, createAttachment, createConversation, createConversation, createLink, createLink, createNote, createNote, delete, getAttachments, getCustomDropdown, getCustomField, getDescription, getLinks, getMentionedInExpressions, getName, getNotes, getURL, isActive, isClosed, reactivate, setDescription, setName

Methods inherited from class com.versionone.om.Entity

equals, get, getChangeComment, getChangeDate, getChangedBy, getCreateComment, getCreateDate, getCreatedBy, getID, getInstance, hashCode, save, save, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getSchedule

public Schedule getSchedule()

Returns:

The Schedule this Iteration belongs in. This must be present.

setSchedule

public void setSchedule(Schedule value)

Parameters:

value - The Schedule this Iteration belongs in. This must be present.

getBeginDate

public DB.DateTime getBeginDate()

Returns:

The begin date or start date of this iteration.

setBeginDate

public void setBeginDate(DB.DateTime value)

Parameters:

value - The begin date or start date of this iteration.

getEndDate

public DB.DateTime getEndDate()

Returns:

The end date of this iteration.

setEndDate

public void setEndDate(DB.DateTime value)

Parameters:

value - The end date of this iteration.

getPrimaryWorkitems

public Collection<PrimaryWorkitem> getPrimaryWorkitems(PrimaryWorkitemFilter filter)

Parameters:

filter - Criteria to filter stories and defects on. Pass a DefectFilter or StoryFilter to get only Defects or Stories, respectively.

Returns:

A collection of stories and defects that belong to this iteration.

getEffortRecords

public Collection<Effort> getEffortRecords(EffortFilter filter)

Parameters:

filter - Criteria to filter Effort records on.

Returns:

A read-only collection of Effort Records that belong to this iteration.

canActivate

public boolean canActivate()

Returns:

True if this iteration is in the future state and can be opened or activated.

activate

public void activate()
              throws UnsupportedOperationException

Open or activate this iteration. Iteration must be in a future state.

Throws:

UnsupportedOperationException - The item is an invalid state for the Operation, e.g. it is already open or active.

isFuture

public boolean isFuture()

Returns:

True if this iteration is marked future.

canMakeFuture

public boolean canMakeFuture()

Returns:

True if this iteration is open or active and can be marked future.

makeFuture

public void makeFuture()
                throws UnsupportedOperationException

Mark this iteration as future. Iteration must be in an open or active state.

Throws:

UnsupportedOperationException - The item is an invalid state for the Operation, e.g. it is already in a future state.

getTotalEstimate

public Double getTotalEstimate(PrimaryWorkitemFilter filter)

Parameters:

filter - Criteria to filter stories and defects on. Pass a DefectFilter or StoryFilter to get only Defects or Stories, respectively.

Returns:

the total estimate for all stories and defects in this iteration optionally filtered.

getTotalDetailEstimate

public Double getTotalDetailEstimate(WorkitemFilter filter)

Parameters:

filter - Criteria to filter workitems on.

Returns:

the total estimate for all workitems in this iteration optionally filtered.

getTotalToDo

public Double getTotalToDo(WorkitemFilter filter)

Parameters:

filter - Criteria to filter workitems on.

Returns:

the total to do for all workitems in this iteration optionally filtered.

getTotalDone

public Double getTotalDone(WorkitemFilter filter)

Parameters:

filter - Criteria to filter workitems on.

Returns:

the total done for all workitems in this iteration optionally filtered.