com.danube.scrumworks.api2
Class BacklogItem

java.lang.Object
  com.danube.scrumworks.api2.BacklogItem

All Implemented Interfaces:

java.io.Serializable

public final class BacklogItem
extends java.lang.Object
implements java.io.Serializable

Contains information about Backlog Items for API users.

See Also:

Serialized Form

Constructor Summary

BacklogItem()
Constructs a new BacklogItem.

BacklogItem(java.lang.Long id)
Constructs a new BacklogItem.

Method Summary

BusinessWeightWSO	getBusinessWeight() Gets the business weight.
java.util.Date	getCompletedDate() Gets the completed date.
java.lang.String	getDescription() Gets the description.
java.lang.Integer	getEstimate() Gets the estimate.
java.lang.Long	getId() Gets the id.
java.lang.String	getKey() Gets the key.
java.lang.String	getName() Gets the name.
java.lang.Long	getProductId() Gets the parent product's id.
double	getRank() Gets the rank.
java.lang.Long	getReleaseId() Gets the release id.
java.lang.Long	getSprintId() Gets the sprint id.
java.lang.Long	getStatusId() Gets the backlog item status id.
java.lang.Long	getTeamId() Gets the backlog item's team, if the item is committed to a kanban team.
java.util.List<Theme>	getThemes() Gets the themes of the backlog item.
boolean	isActive() Checks if the backlog item is active.
boolean	isDone() Checks if the backlog item is done.
void	setActive(boolean active) Sets the backlog item active.
void	setBusinessWeight(BusinessWeightWSO businessWeight) Sets the business weight.
void	setCompletedDate(java.util.Date completedDate) Sets the completed date.
void	setDescription(java.lang.String description) Sets the description.
void	setEstimate(java.lang.Integer estimate) Sets the estimate.
void	setId(java.lang.Long id) Sets the new id.
void	setKey(java.lang.String key) Sets the key.
void	setName(java.lang.String name) Sets the name.
void	setProductId(java.lang.Long productId) Sets the parent product's 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	setStatusId(java.lang.Long statusId) Sets the backlog item status id to use.
void	setTeamId(java.lang.Long teamId) Sets the backlog item's team, if the item is committed to a kanban team.
void	setThemes(java.util.List<Theme> themes) Sets the themes of the backlog item.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BacklogItem

public BacklogItem()

Constructs a new BacklogItem.

BacklogItem

public BacklogItem(java.lang.Long id)

Constructs a new BacklogItem.

Parameters:

id - the backlog item ID

Throws:

java.lang.IllegalArgumentException - if the argument is null

Method Detail

getId

public java.lang.Long getId()

Gets the id.

Returns:

the ID of the backlog item

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

getName

public java.lang.String getName()

Gets the name.

Returns:

the name

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - the new name

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 new description

setId

public void setId(java.lang.Long id)

Sets the new id.

Parameters:

id - the new id

getEstimate

public java.lang.Integer getEstimate()

Gets the estimate.

Returns:

the estimate

setEstimate

public void setEstimate(java.lang.Integer estimate)

Sets the estimate.

Parameters:

estimate - the new estimate

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()

Gets the rank.

Returns:

the rank

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

setSprintId

public void setSprintId(java.lang.Long sprintId)

Sets the sprint id.

Parameters:

sprintId - the new sprint id

isActive

public boolean isActive()

Checks if the backlog item is active.

Returns:

true, if the backlog item is active

setActive

public void setActive(boolean active)

Sets the backlog item active.

Parameters:

active - whether the backlog item is active

getCompletedDate

public java.util.Date getCompletedDate()

Gets the completed date.

Returns:

the completed date

setCompletedDate

public void setCompletedDate(java.util.Date completedDate)

Sets the completed date.

Parameters:

completedDate - the new completed date

isDone

public boolean isDone()

Checks if the backlog item is done.

Returns:

true, if the backlog item is done

getThemes

public java.util.List<Theme> getThemes()

Gets the themes of the backlog item.

Returns:

the themes

setThemes

public void setThemes(java.util.List<Theme> themes)

Sets the themes of the backlog item.

Parameters:

themes - the new themes

getProductId

public java.lang.Long getProductId()

Gets the parent product's id.

Returns:

the product id

setProductId

public void setProductId(java.lang.Long productId)

Sets the parent product's id.

Parameters:

productId - the new product id

getTeamId

public java.lang.Long getTeamId()

Gets the backlog item's team, if the item is committed to a kanban team. For sprint backlog items or uncommitted backlog items, team id will not be present.

Returns:

the team id

setTeamId

public void setTeamId(java.lang.Long teamId)

Sets the backlog item's team, if the item is committed to a kanban team. For sprint backlog items or uncommitted backlog items, this will be null.

Parameters:

teamId - the team id

getStatusId

public java.lang.Long getStatusId()

Gets the backlog item status id.

Returns:

the backlog item status.

setStatusId

public void setStatusId(java.lang.Long statusId)

Sets the backlog item status id to use.

Parameters:

statusId - the status to use.

Throws:

java.lang.IllegalArgumentException - if the argument is null.