com.danube.scrumworks.api.wso
Class BacklogItemWSO

java.lang.Object
  com.danube.scrumworks.api.wso.BacklogItemWSO

All Implemented Interfaces:

com.danube.scrumworks.util.HasRank, java.io.Serializable

public final class BacklogItemWSO
extends java.lang.Object
implements com.danube.scrumworks.util.HasRank, java.io.Serializable

Web Service Object for representing Backlog Items.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.danube.scrumworks.util.HasRank

com.danube.scrumworks.util.HasRank.RankComparator, com.danube.scrumworks.util.HasRank.RankExtractor

Field Summary

Fields inherited from interface com.danube.scrumworks.util.HasRank

COMPARATOR

Constructor Summary

BacklogItemWSO()
Constructs a new BacklogItemWSO.

BacklogItemWSO(java.lang.Long backlogItemId, java.lang.String title, java.lang.String description, java.lang.Integer estimate, BusinessWeightWSO businessWeight, double rank, java.lang.Long releaseId, java.lang.Long sprintId, boolean active, java.util.Date completed, ThemeWSO[] themes, java.lang.Long groupId, java.lang.String key, java.lang.Long productId)
Constructs a new BacklogItemWSO.

Method Summary

boolean	equals(java.lang.Object other)
java.lang.Long	getBacklogItemId() Gets the backlog item ID.
BusinessWeightWSO	getBusinessWeight() Gets the business weight.
java.util.Date	getCompletedDate() Gets the date the backlog item was marked done.
java.lang.String	getDescription() Gets the description.
java.lang.Integer	getEstimate() Gets the item's estimate.
java.lang.Long	getGroupId() Gets the group ID.
java.lang.String	getKey() Gets the key.
java.lang.Long	getProductId() Gets the product id.
double	getRank()
java.lang.Long	getReleaseId() Gets the release id.
java.lang.Long	getSprintId() Gets the sprint id.
ThemeWSO[]	getThemes()
java.lang.String	getTitle() Gets the title.
boolean	hasCompletedDate() Returns true if this item has a completed date set.
int	hashCode()
boolean	isActive()
void	setActive(boolean active) Sets whether or not the backlog item is active (not deleted).
void	setBacklogItemId(java.lang.Long backlogItemId) Sets the backlog item's ID.
void	setBusinessWeight(BusinessWeightWSO businessWeight) Sets the business weight.
void	setCompletedDate(java.util.Date completedDate) Sets the date the item was completed.
void	setDescription(java.lang.String description) Sets the description.
void	setEstimate(java.lang.Integer estimate) Sets the estimate.
void	setGroupId(java.lang.Long groupId) Sets the group ID.
void	setKey(java.lang.String key) Sets the key.
void	setProductId(java.lang.Long productId) Sets the product id.
void	setRank(double rank) Sets the rank.
void	setReleaseId(java.lang.Long releaseId) Sets the release id.
void	setSprintId(java.lang.Long sprintId) Sets the sprint id.
void	setThemes(ThemeWSO[] themes) Sets the themes associated with this item.
void	setTitle(java.lang.String title) Sets the title.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BacklogItemWSO

public BacklogItemWSO()

Constructs a new BacklogItemWSO.

BacklogItemWSO

public BacklogItemWSO(java.lang.Long backlogItemId,
                      java.lang.String title,
                      java.lang.String description,
                      java.lang.Integer estimate,
                      BusinessWeightWSO businessWeight,
                      double rank,
                      java.lang.Long releaseId,
                      java.lang.Long sprintId,
                      boolean active,
                      java.util.Date completed,
                      ThemeWSO[] themes,
                      java.lang.Long groupId,
                      java.lang.String key,
                      java.lang.Long productId)

Constructs a new BacklogItemWSO.

Parameters:

backlogItemId - the backlog item's ID

title - the title

description - the description

estimate - the estimate or null for unestimated

businessWeight - the business weight or null for no business weight

rank - the rank

releaseId - the release ID

sprintId - the sprint ID or null for uncommitted

active - true if the PBI is active (not deleted)

completed - the date the item was completed or null if not completed

themes - the themes applied to the backlog item

groupId - the ID of the group the PBI is in. Ignored after release 4.3.

key - the PBI's key

productId - the product ID

Method Detail

isActive

public boolean isActive()

Returns:

true if the backlog item is active (not deleted)

setActive

public void setActive(boolean active)

Sets whether or not the backlog item is active (not deleted).

Parameters:

active - true if the backlog item is active (not deleted)

getBacklogItemId

public java.lang.Long getBacklogItemId()

Gets the backlog item ID.

Returns:

the ID

setBacklogItemId

public void setBacklogItemId(java.lang.Long backlogItemId)

Sets the backlog item's ID.

Parameters:

backlogItemId - the ID of the backlog item

getCompletedDate

public java.util.Date getCompletedDate()

Gets the date the backlog item was marked done.

Returns:

the completed date or null if the item is not completed

setCompletedDate

public void setCompletedDate(java.util.Date completedDate)

Sets the date the item was completed.

Parameters:

completedDate - the date the item was completed or null if not done

getDescription

public java.lang.String getDescription()

Gets the description.

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - the description

getEstimate

public java.lang.Integer getEstimate()

Gets the item's estimate.

Returns:

the estimate or null if unestimated

setEstimate

public void setEstimate(java.lang.Integer estimate)

Sets the estimate.

Parameters:

estimate - the estimate or null if unestimated

getBusinessWeight

public BusinessWeightWSO getBusinessWeight()

Gets the business weight.

Returns:

the business weight

setBusinessWeight

public void setBusinessWeight(BusinessWeightWSO businessWeight)

Sets the business weight.

Parameters:

businessWeight - the new business weight

getRank

public double getRank()

Specified by:

getRank in interface com.danube.scrumworks.util.HasRank

setRank

public void setRank(double rank)

Sets the rank.

Parameters:

rank - the new rank

getReleaseId

public java.lang.Long getReleaseId()

Gets the release id.

Returns:

the release id

setReleaseId

public void setReleaseId(java.lang.Long releaseId)

Sets the release id.

Parameters:

releaseId - the new release id

getSprintId

public java.lang.Long getSprintId()

Gets the sprint id.

Returns:

the sprint ID or null if the item is uncommitted

setSprintId

public void setSprintId(java.lang.Long sprintId)

Sets the sprint id.

Parameters:

sprintId - the new sprint id or null if the item is uncommitted

getTitle

public java.lang.String getTitle()

Gets the title.

Returns:

the title

setTitle

public void setTitle(java.lang.String title)

Sets the title.

Parameters:

title - the new title

getThemes

public ThemeWSO[] getThemes()

Returns:

the themes associated with this item.

setThemes

public void setThemes(ThemeWSO[] themes)

Sets the themes associated with this item.

Parameters:

themes - the themes for this item. null and empty both indicate no themes.

getGroupId

public java.lang.Long getGroupId()

Gets the group ID. Always returns null for versions of ScrumWorks later than 4.3.

Returns:

null

setGroupId

public void setGroupId(java.lang.Long groupId)

Sets the group ID. It is not saved to the server after ScrumWorks 4.3.

Parameters:

groupId - the group ID

getKey

public java.lang.String getKey()

Gets the key.

Returns:

the key

setKey

public void setKey(java.lang.String key)

Sets the key.

Parameters:

key - the new key

getProductId

public java.lang.Long getProductId()

Gets the product id.

Returns:

the product id

setProductId

public void setProductId(java.lang.Long productId)

Sets the product id.

Parameters:

productId - the new product id

hasCompletedDate

public boolean hasCompletedDate()

Returns true if this item has a completed date set.

Returns:

true if completedDate is not null

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object