com.versionone.om
Class Workitem

java.lang.Object
  com.versionone.om.Entity
      com.versionone.om.BaseAsset
          com.versionone.om.ProjectAsset
              com.versionone.om.Workitem

Direct Known Subclasses:

PrimaryWorkitem, SecondaryWorkitem

public abstract class Workitem
extends ProjectAsset

Base class for Stories, Defects, Tasks, Tests.

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

boolean	canTrack()
Effort	createEffort(double value) Log an effort record against this workitem.
Effort	createEffort(double value, java.util.Map<java.lang.String,java.lang.Object> attributes) Log an effort record against this workitem.
Effort	createEffort(double value, Member member) Log an effort record against this workitem with the current day and time and given member and value.
Effort	createEffort(double value, Member member, DateTime date) Log an effort record against this workitem with the current day and time and given member and value.
Effort	createEffort(double value, Member member, DateTime date, java.util.Map<java.lang.String,java.lang.Object> attributes) Log an effort record against this workitem with the current day and time and given member and value.
java.lang.Double	getDetailEstimate()
java.lang.Double	getDone()
java.util.Collection<Effort>	getEffortRecords(EffortFilter filter) Gets Effort Records tracked against this Workitem.
java.util.Collection<Member>	getOwners()
java.lang.String	getReference()
java.lang.Double	getToDo()
void	setDetailEstimate(java.lang.Double detailEstimate)
void	setReference(java.lang.String value)
void	setToDo(java.lang.Double toDo)

Methods inherited from class com.versionone.om.ProjectAsset

getDisplayID, getProject, setProject

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, getName, getNotes, getReferencedInExpressions, 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

canTrack

public boolean canTrack()

Returns:

Returns true if this workitem detail estimate and todo can be updated.

getOwners

public java.util.Collection<Member> getOwners()

Returns:

Members that own this item.

getDetailEstimate

public java.lang.Double getDetailEstimate()

Returns:

detail's estimation.

setDetailEstimate

public void setDetailEstimate(java.lang.Double detailEstimate)

Parameters:

detailEstimate - Estimate of effort required to implement this item.

Throws:

java.lang.IllegalStateException - If setting DetailEstimate is not allowed at this level.

getDone

public java.lang.Double getDone()

Returns:

Effort already expended to implement this item.

getToDo

public java.lang.Double getToDo()

Returns:

Remaining effort required to complete implementation of this item.

setToDo

public void setToDo(java.lang.Double toDo)
             throws java.lang.IllegalStateException

Parameters:

toDo - Remaining effort required to complete implementation of this item.

Throws:

java.lang.IllegalStateException - if setting DetailEstimate is not allowed at this level.

getEffortRecords

public java.util.Collection<Effort> getEffortRecords(EffortFilter filter)

Gets Effort Records tracked against this Workitem.

Parameters:

filter - Criteria to filter on. If null, all tasks and tests in the project are returned.

Returns:

selected Effort records.

getReference

public java.lang.String getReference()

Returns:

Cross-reference of this item with an external system.

setReference

public void setReference(java.lang.String value)

Parameters:

value - Cross-reference of this item with an external system.

createEffort

public Effort createEffort(double value)

Log an effort record against this workitem.

Parameters:

value - of the Effort.

Returns:

created Effort.

Throws:

java.lang.IllegalStateException - Effort Tracking is not enabled.

createEffort

public Effort createEffort(double value,
                           java.util.Map<java.lang.String,java.lang.Object> attributes)

Log an effort record against this workitem.

Parameters:

value - of the Effort.

attributes - additional attributes for the Effort record.

Returns:

created Effort.

Throws:

java.lang.IllegalStateException - Effort Tracking is not enabled.

createEffort

public Effort createEffort(double value,
                           Member member)

Log an effort record against this workitem with the current day and time and given member and value.

Parameters:

member - The subject of the Effort.

value - if the Effort.

Returns:

created Effort record.

Throws:

java.lang.IllegalStateException - if Effort tracking is not enabled.

createEffort

public Effort createEffort(double value,
                           Member member,
                           DateTime date)

Log an effort record against this workitem with the current day and time and given member and value.

Parameters:

member - The subject of the Effort.

value - if the Effort.

date - of the Effort record.

Returns:

created Effort record.

Throws:

java.lang.IllegalStateException - if Effort tracking is not enabled.

createEffort

public Effort createEffort(double value,
                           Member member,
                           DateTime date,
                           java.util.Map<java.lang.String,java.lang.Object> attributes)

Log an effort record against this workitem with the current day and time and given member and value.

Parameters:

member - The subject of the Effort.

value - if the Effort.

date - of the Effort record.

attributes - additional attributes for the Effort record.

Returns:

created Effort record.

Throws:

java.lang.IllegalStateException - if Effort tracking is not enabled.