CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class TrackerItemDto

java.lang.Object
  extended by com.intland.codebeamer.persistence.dto.base.IdentifiableDto
      extended by com.intland.codebeamer.persistence.dto.base.NamedDto
          extended by com.intland.codebeamer.persistence.dto.base.DescribeableDto
              extended by com.intland.codebeamer.persistence.dto.TrackerItemDto
All Implemented Interfaces:
BaseDto, IndexableDto, ProjectAwareDto, ReferableDto, WriteControlledDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class TrackerItemDto
extends DescribeableDto
implements ReferableDto, ProjectAwareDto, IndexableDto, WriteControlledDto

Wraps a tracker item.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.DescribeableDto
DescribeableDto.DescriptionComparator
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto
NamedDto.NameComparator
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
IdentifiableDto.IdComparator
 
Nested classes/interfaces inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
ReferableDto.DescriptionComparator
 
Field Summary
static java.lang.String CI_PREFIX
          URL prefix for configuration items.
static java.lang.String CONFIG_ITEM_LINK_TYPE
           
static java.lang.String INTERWIKI_LINK_TYPE
           
static java.lang.String INTERWIKI_LINK_TYPE_BUG
          Deprecated. Use INTERWIKI_LINK_TYPE instead.
static java.lang.String INTERWIKI_LINK_TYPE_TASK
          Deprecated. Use INTERWIKI_LINK_TYPE instead.
static int STATUS_CLOSED
          TODO: This constant depends on implicit assumptions and should be removed
static java.lang.String URL_PREFIX
          URL prefix for tracker items.
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER
 
Constructor Summary
TrackerItemDto()
           
TrackerItemDto(java.lang.Integer id)
          Convenience constructor with an id
TrackerItemDto(TrackerItemDto item)
           
 
Method Summary
 TrackerItemDto clone()
          Create a clone of this item/issue
 int compareTo(java.lang.Object obj)
          Caution: NamedDto compareTo violates the rule that a.equals(b) is equivalent to a.compareTo(b) == 0, because only the names are compared
static int compareTrackerItems(TrackerItemDto i1, TrackerItemDto i2)
          Compare two TrackerItems that may be null
 boolean equals(java.lang.Object obj)
           
 UserDto getApprover()
          Get the user to approve this item/issue
 java.util.Date getAssignedAt()
          Get the last date and time when the user/role assignment has changed
 java.util.List<? extends NamedDto> getAssignedTo()
          Get the users or roles assigned to this issue/item
 java.util.List<? extends NamedDto> getCategories()
          Get the categories associated with this item/issue
 java.util.List<TrackerItemDto> getChildren()
          Get the list of children of this item (at least the child IDs) Note: Not all properties of the TrackerItemDtos in this list are set (especially custom fields and choice lists are not set)
 java.util.List<? extends NamedDto> getChoiceField0s()
          Deprecated. use getChoiceList(0) instead
 java.util.List<? extends NamedDto> getChoiceField1s()
          Deprecated. use getChoiceList(1) instead
 java.util.List<? extends NamedDto> getChoiceField2s()
          Deprecated. use getChoiceList(2) instead
 java.util.List<? extends NamedDto> getChoiceField3s()
          Deprecated. use getChoiceList(3) instead
 java.util.Map<java.lang.Integer,java.util.List<? extends NamedDto>> getChoiceList()
          Get the Map of user defined choice lists: Key = choice index, Value = choice List
 java.util.List<? extends NamedDto> getChoiceList(int idx)
          Get the idx.th user defined choice list
 java.util.Date getClosedAt()
          Get the actual close/end date of this issue/item
 java.util.Map<java.lang.Integer,java.lang.String> getCustomField()
          Get the Map of user defined field values: Key = field index, Value = field value
 java.lang.String getCustomField(int idx)
          Get the idx.th user defined field value
 java.util.List<TrackerItemDto> getDependency()
          Get the List of other items/issues associated with this item/issue
 java.util.Date getEndDate()
          Get the intended/planned end date (and time) of this issue/item
 java.lang.Double getEstimatedHours()
          Get the estimated effort to resolve this issue/item in hours
 java.lang.String getFileRevisionAtClose()
          Deprecated.  
 java.lang.String getFileRevisionAtSubmit()
          Deprecated.  
 java.lang.Boolean getHasCommits()
          Check if any SCM commits are associated with this item/issue
 java.lang.String getIconUrl()
          Returns the URL of the (small) icon image that represents this DTO type.
 java.lang.String getInterwikiLink()
          Returns the interwiki link that points to the web page where this DTO is managed.
 java.lang.String getKeyAndId()
           
 java.util.List<? extends NamedDto> getMilestones()
          Get the milestones associated with this item/issue
 java.util.Date getModifiedAt()
          Get the date and time of the last issue/item modification
 UserDto getModifier()
          Get the user that made the last modification
 NamedDto getNamedPriority()
          Get the priority of this issue/item
 java.lang.Integer getNoOfAttachments()
          Get the number of attachments associated with this item/issue
 java.util.List<? extends NamedDto> getOses()
          Get the operating systems associated with this issue/item
 IdentifiableDto getParent()
          Get the parent item of this item
 TrackerItemDto getParentItem()
          Get the parent item of this item
 java.util.List<? extends NamedDto> getPlatforms()
          Get the platforms associated with this item/issue
 java.lang.Integer getPriority()
          Old style priority getter to be backwards compatible.
 ProjectDto getProject()
          Get the project this item/issue belongs to
 java.util.List<? extends IdentifiableDto> getReferers()
          Get the List of objects referring to this item/issue
 java.util.List<? extends NamedDto> getResolutions()
          Get the resolutions associated with this issue/item
 java.util.List<?> getScmCommits()
          Deprecated. this information is no longer available here
 java.util.List<? extends NamedDto> getSeverities()
          Get the severities associated with this item/issue
 java.lang.String getShortDescription()
          Get a short description of this item/issue.
 java.lang.Double getSpentEstimatedHours()
          Get the ratio of spentHours/estimatedHours in percent
 java.lang.Double getSpentHours()
          Get the actual/accumulated effort spent on this issue/item in hours
 java.util.Date getStartDate()
          Get the intended/planned start date (and time) of this issue/item
 NamedDto getStatus()
          Get the status of this issue/item
 java.util.Date getSubmittedAt()
          Get the date and time this issue/item was submitted/created
 UserDto getSubmitter()
          Get the user that originally submitted/created this issue/item
 java.lang.String getSubmitterEmail()
          Deprecated. use getSubmitter().getEmail() directly
 java.lang.String getSummary()
          Deprecated. Use NamedDto.getName() or getShortDescription() instead
 java.util.List<? extends NamedDto> getSupervisors()
          Get the users or roles supervising this issue/item
 TrackerDto getTracker()
          Get the Tracker this item/issue belongs to
 java.lang.String getTypeName()
          Get the type name of this item/issue
 java.lang.String getUndefined0()
          Deprecated. use getCustomField(0) instead
 java.lang.String getUndefined1()
          Deprecated. use getCustomField(1) instead
 java.lang.String getUndefined10()
          Deprecated. use getCustomField(10) instead
 java.lang.String getUndefined11()
          Deprecated. use getCustomField(11) instead
 java.lang.String getUndefined12()
          Deprecated. use getCustomField(12) instead
 java.lang.String getUndefined13()
          Deprecated. use getCustomField(13) instead
 java.lang.String getUndefined14()
          Deprecated. use getCustomField(14) instead
 java.lang.String getUndefined15()
          Deprecated. use getCustomField(15) instead
 java.lang.String getUndefined16()
          Deprecated. use getCustomField(16) instead
 java.lang.String getUndefined17()
          Deprecated. use getCustomField(17) instead
 java.lang.String getUndefined18()
          Deprecated. use getCustomField(18) instead
 java.lang.String getUndefined19()
          Deprecated. use getCustomField(19) instead
 java.lang.String getUndefined2()
          Deprecated. use getCustomField(2) instead
 java.lang.String getUndefined20()
          Deprecated. use getCustomField(20) instead
 java.lang.String getUndefined21()
          Deprecated. use getCustomField(21) instead
 java.lang.String getUndefined22()
          Deprecated. use getCustomField(22) instead
 java.lang.String getUndefined23()
          Deprecated. use getCustomField(23) instead
 java.lang.String getUndefined24()
          Deprecated. use getCustomField(24) instead
 java.lang.String getUndefined25()
          Deprecated. use getCustomField(25) instead
 java.lang.String getUndefined3()
          Deprecated. use getCustomField(3) instead
 java.lang.String getUndefined4()
          Deprecated. use getCustomField(4) instead
 java.lang.String getUndefined5()
          Deprecated. use getCustomField(5) instead
 java.lang.String getUndefined6()
          Deprecated. use getCustomField(6) instead
 java.lang.String getUndefined7()
          Deprecated. use getCustomField(7) instead
 java.lang.String getUndefined8()
          Deprecated. use getCustomField(8) instead
 java.lang.String getUndefined9()
          Deprecated. use getCustomField(9) instead
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 java.util.List<? extends NamedDto> getVersions()
          Get the versions associated with this issue/item
 int hashCode()
           
 boolean isAggregated()
          Check if this item contains aggregated child values (e.g.
 boolean isClosed()
          TODO: This method depends on implicit assumptions and should be removed or refactored Check whether this item/issue is closed or not.
 boolean isConfigItem()
          Check whether this object represents a CMDB Configuration Item or a Tracker Item (issue)
 boolean isDeleted()
          Check whether this item/issue has been (logically) deleted
 boolean isIndexed()
          Check whether this item/issue has been indexed for search
 boolean isSubTask()
          Check if this issue/item is child of another issue/item
 boolean isWaitingForApproval()
          Check whether an approver exists or not
 boolean isWritable()
          Check whether this item/issue is writable/editable for the current user
 void setAggregated(boolean aggregated)
          Set whether this item contains own values or aggregated child values (e.g.
 void setApprover(UserDto approver)
          Set the user to approve this item/issue
 void setAssignedAt(java.util.Date assignedAt)
          Set the last date and time when the user/role assignment has changed
 void setAssignedTo(java.util.List<? extends NamedDto> assignedTo)
          Set the users or roles assigned to this issue/item
 void setCategories(java.util.List<? extends NamedDto> categories)
          Set the categories to be associated with this item/issue
 void setChildren(java.util.List<TrackerItemDto> children)
          Set the list of child-/sub-items of this item.
 void setChoiceField0s(java.util.List<? extends NamedDto> value)
          Deprecated. use setChoiceList(0, value) instead
 void setChoiceField1s(java.util.List<? extends NamedDto> value)
          Deprecated. use setChoiceList(1, value) instead
 void setChoiceField2s(java.util.List<? extends NamedDto> value)
          Deprecated. use setChoiceList(2, value) instead
 void setChoiceField3s(java.util.List<? extends NamedDto> value)
          Deprecated. use setChoiceList(3, value) instead
 void setChoiceList(int idx, java.util.List<? extends NamedDto> value)
          Set the value of the idx.th user defined choice list
 void setClosedAt(java.util.Date closedAt)
          Set the actual close/end date of this issue/item
 void setCustomField(int idx, java.lang.String value)
          Set the value of the idx.th user defined field
 void setDeleted(boolean deleted)
          Set whether this item/issue has been (logically) deleted
 void setDependency(java.util.List<TrackerItemDto> dependency)
          Set the List of other items/issues to be associated with this item/issue Note: Changes to this property are not persistent!
 void setEndDate(java.util.Date endDate)
          Set the intended/planned end date (and time) of this issue/item
 void setEstimatedHours(java.lang.Double estimatedHours)
          Set the estimated effort to resolve this issue/item in hours
 void setFileRevisionAtClose(java.lang.String fileRevisionAtClose)
          Deprecated.  
 void setFileRevisionAtSubmit(java.lang.String fileRevisionAtSubmit)
          Deprecated.  
 void setHasCommits(java.lang.Boolean hasCommits)
          Set whether any SCM commits are associated with this item/issue Note: Changes to this property are not persistent
 void setIndexed(boolean indexed)
          Set whether this item/issue has been indexed for search Note: Changes to this property are not persistent
 void setMilestones(java.util.List<? extends NamedDto> milestones)
          Set the milestones to be associated with this item/issue
 void setModifiedAt(java.util.Date modifiedAt)
          Set the date and time of the last issue/item modification
 void setModifier(UserDto modifier)
          Set the user that made the last modification
 void setNamedPriority(NamedDto priority)
          Set the priority of this issue/item
 void setNoOfAttachments(java.lang.Integer noOfAttachments)
          Set the number of attachments associated with this item/issue Note: Changes to this property are not persistent
 void setOses(java.util.List<? extends NamedDto> oses)
          Set the operating systems to be associated with this issue
 void setParent(IdentifiableDto parent)
          Set the (ID of the) parent item of this item
 void setPlatforms(java.util.List<? extends NamedDto> platforms)
          Set the platforms to be associated with this issue
 void setPriority(java.lang.Integer prio)
          Old style priority setter to be backwards compatible.
 void setProject(ProjectDto project)
          Deprecated.  
 void setReferers(java.util.List<? extends IdentifiableDto> referers)
          Set the List of objects referring to this item/issue Note: Changes to this property are not persistent!
 void setResolutions(java.util.List<? extends NamedDto> resolutions)
          Set the resolutions to be associated with this issue
 void setScmCommits(java.util.List<?> scmCommits)
          Deprecated. this information is no longer available here
 void setSeverities(java.util.List<? extends NamedDto> severities)
          Set the severities to be associated with this item/issue
 void setSpentHours(java.lang.Double spentHours)
          Set the actual/accumulated effort spent on this issue/item in hours
 void setStartDate(java.util.Date startDate)
          Set the intended/planned start date (and time) of this issue/item
 void setStatus(NamedDto status)
          Set the status of this issue/item
 void setSubmittedAt(java.util.Date submittedAt)
          Set the date and time this issue/item was submitted/created
 void setSubmitter(UserDto submitter)
          Set the user that originally submitted/created this issue/item
 void setSubmitterEmail(java.lang.String submitterEmail)
          Deprecated. Does nothing, will be removed in future release
 void setSummary(java.lang.String summary)
          Deprecated. Use NamedDto.setName(String) instead
 void setSupervisors(java.util.List<? extends NamedDto> supervisors)
          Set the users or roles to supervise this issue/item
 void setTracker(TrackerDto tracker)
          Set the Tracker this item/issue belongs to
 void setUndefined0(java.lang.String value)
          Deprecated. use setCustomField(0, value) instead
 void setUndefined1(java.lang.String value)
          Deprecated. use setCustomField(1, value) instead
 void setUndefined10(java.lang.String value)
          Deprecated. use setCustomField(10, value) instead
 void setUndefined11(java.lang.String value)
          Deprecated. use setCustomField(11, value) instead
 void setUndefined12(java.lang.String value)
          Deprecated. use setCustomField(12, value) instead
 void setUndefined13(java.lang.String value)
          Deprecated. use setCustomField(13, value) instead
 void setUndefined14(java.lang.String value)
          Deprecated. use setCustomField(14, value) instead
 void setUndefined15(java.lang.String value)
          Deprecated. use setCustomField(15, value) instead
 void setUndefined16(java.lang.String value)
          Deprecated. use setCustomField(16, value) instead
 void setUndefined17(java.lang.String value)
          Deprecated. use setCustomField(17, value) instead
 void setUndefined18(java.lang.String value)
          Deprecated. use setCustomField(18, value) instead
 void setUndefined19(java.lang.String value)
          Deprecated. use setCustomField(19, value) instead
 void setUndefined2(java.lang.String value)
          Deprecated. use setCustomField(2, value) instead
 void setUndefined20(java.lang.String value)
          Deprecated. use setCustomField(20, value) instead
 void setUndefined21(java.lang.String value)
          Deprecated. use setCustomField(21, value) instead
 void setUndefined22(java.lang.String value)
          Deprecated. use setCustomField(22, value) instead
 void setUndefined23(java.lang.String value)
          Deprecated. use setCustomField(23, value) instead
 void setUndefined24(java.lang.String value)
          Deprecated. use setCustomField(24, value) instead
 void setUndefined25(java.lang.String value)
          Deprecated. use setCustomField(25, value) instead
 void setUndefined3(java.lang.String value)
          Deprecated. use setCustomField(3, value) instead
 void setUndefined4(java.lang.String value)
          Deprecated. use setCustomField(4, value) instead
 void setUndefined5(java.lang.String value)
          Deprecated. use setCustomField(5, value) instead
 void setUndefined6(java.lang.String value)
          Deprecated. use setCustomField(6, value) instead
 void setUndefined7(java.lang.String value)
          Deprecated. use setCustomField(7, value) instead
 void setUndefined8(java.lang.String value)
          Deprecated. use setCustomField(8, value) instead
 void setUndefined9(java.lang.String value)
          Deprecated. use setCustomField(9, value) instead
 void setVersions(java.util.List<? extends NamedDto> versions)
          Set the versions to be associated with this issue
 void setWritable(boolean editable)
          Set whether this item/issue is writable/editable for the current user Note: Changes to this property are not persistent
 java.lang.String toString()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.DescribeableDto
compareByDescription, getDescription, getDescriptionFormat, setDescription, setDescriptionFormat
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto
compareNames, compareString, compareStringIgnoreCase, createLookupMap, getName, setName
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
compare, compareInteger, equals, getId, hashCode, setId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

INTERWIKI_LINK_TYPE

public static final java.lang.String INTERWIKI_LINK_TYPE
See Also:
Constant Field Values

CONFIG_ITEM_LINK_TYPE

public static final java.lang.String CONFIG_ITEM_LINK_TYPE
See Also:
Constant Field Values

INTERWIKI_LINK_TYPE_BUG

public static final java.lang.String INTERWIKI_LINK_TYPE_BUG
Deprecated. Use INTERWIKI_LINK_TYPE instead.
See Also:
Constant Field Values

INTERWIKI_LINK_TYPE_TASK

public static final java.lang.String INTERWIKI_LINK_TYPE_TASK
Deprecated. Use INTERWIKI_LINK_TYPE instead.
See Also:
Constant Field Values

STATUS_CLOSED

public static final int STATUS_CLOSED
TODO: This constant depends on implicit assumptions and should be removed

See Also:
Constant Field Values

URL_PREFIX

public static final java.lang.String URL_PREFIX
URL prefix for tracker items.

See Also:
Constant Field Values

CI_PREFIX

public static final java.lang.String CI_PREFIX
URL prefix for configuration items.

See Also:
Constant Field Values
Constructor Detail

TrackerItemDto

public TrackerItemDto()

TrackerItemDto

public TrackerItemDto(java.lang.Integer id)
Convenience constructor with an id

Parameters:
id - The id for tracker-item

TrackerItemDto

public TrackerItemDto(TrackerItemDto item)
Method Detail

clone

public TrackerItemDto clone()
Create a clone of this item/issue

Overrides:
clone in class IdentifiableDto
Returns:
a clone of this item/issue

getProject

public ProjectDto getProject()
Get the project this item/issue belongs to

Specified by:
getProject in interface ProjectAwareDto
Returns:
the item's project

setProject

public void setProject(ProjectDto project)
Deprecated. 

This is a noop: Only kept for backwards compatibility

Specified by:
setProject in interface ProjectAwareDto

getTracker

public TrackerDto getTracker()
Get the Tracker this item/issue belongs to

Returns:
the item's tracker

setTracker

public void setTracker(TrackerDto tracker)
Set the Tracker this item/issue belongs to

Parameters:
tracker - to set

getParentItem

public TrackerItemDto getParentItem()
Get the parent item of this item

Returns:
the parent item, or null if this is a top-level item

getParent

public IdentifiableDto getParent()
Get the parent item of this item

Returns:
the parent item, or null if this is a top-level item

setParent

public void setParent(IdentifiableDto parent)
Set the (ID of the) parent item of this item

Parameters:
parent - is the (ID of the) parent item, or null (no parent item)

isSubTask

public boolean isSubTask()
Check if this issue/item is child of another issue/item

Returns:
true this issue/item is child of another issue/item, otherwise false

getChildren

public java.util.List<TrackerItemDto> getChildren()
Get the list of children of this item (at least the child IDs) Note: Not all properties of the TrackerItemDtos in this list are set (especially custom fields and choice lists are not set)

Returns:
the List of children (partially populated TrackerItemDtos)

setChildren

public void setChildren(java.util.List<TrackerItemDto> children)
Set the list of child-/sub-items of this item. Note: Changes to this property are not persistent!

Parameters:
children - is a list of child-/sub-item IDs

getDependency

public java.util.List<TrackerItemDto> getDependency()
Get the List of other items/issues associated with this item/issue

Returns:
a List of other items/issues associated with this item/issue, or null if not set

setDependency

public void setDependency(java.util.List<TrackerItemDto> dependency)
Set the List of other items/issues to be associated with this item/issue Note: Changes to this property are not persistent!

Parameters:
dependency - is a List of other items/issues to be associated with this item/issue, or null

getReferers

public java.util.List<? extends IdentifiableDto> getReferers()
Get the List of objects referring to this item/issue

Returns:
a List of objects referring to this item/issue, or null if not set

setReferers

public void setReferers(java.util.List<? extends IdentifiableDto> referers)
Set the List of objects referring to this item/issue Note: Changes to this property are not persistent!

Parameters:
referers - is a List of objects referring to this item/issue, or null

getSubmittedAt

public java.util.Date getSubmittedAt()
Get the date and time this issue/item was submitted/created

Returns:
the submit/creation date of this issue/item

setSubmittedAt

public void setSubmittedAt(java.util.Date submittedAt)
Set the date and time this issue/item was submitted/created

Parameters:
submittedAt - date

getSubmitter

public UserDto getSubmitter()
Get the user that originally submitted/created this issue/item

Returns:
user that originally submitted/created this issue/item

setSubmitter

public void setSubmitter(UserDto submitter)
Set the user that originally submitted/created this issue/item

Parameters:
submitter - of this issue/item

getSubmitterEmail

public java.lang.String getSubmitterEmail()
Deprecated. use getSubmitter().getEmail() directly

Only kept for formal backwards compatibility.


setSubmitterEmail

public void setSubmitterEmail(java.lang.String submitterEmail)
Deprecated. Does nothing, will be removed in future release

This is a noop: Only kept for formal backwards compatibility.


getModifiedAt

public java.util.Date getModifiedAt()
Get the date and time of the last issue/item modification

Returns:
the date and time of the last issue/item modification

setModifiedAt

public void setModifiedAt(java.util.Date modifiedAt)
Set the date and time of the last issue/item modification

Parameters:
modifiedAt - date (and time) to set

getModifier

public UserDto getModifier()
Get the user that made the last modification

Returns:
the user that made the last modification, or null if no modification has occured yet

setModifier

public void setModifier(UserDto modifier)
Set the user that made the last modification

Parameters:
modifier - is the user that made the last modification, or null if no modification has occured yet

getApprover

public UserDto getApprover()
Get the user to approve this item/issue

Returns:
the user to approve this item/issue, or null if not set

setApprover

public void setApprover(UserDto approver)
Set the user to approve this item/issue

Parameters:
approver - of this item/issue, or null

isWaitingForApproval

public boolean isWaitingForApproval()
Check whether an approver exists or not

Returns:
true if an approver is set, otherwise false

getAssignedTo

public java.util.List<? extends NamedDto> getAssignedTo()
Get the users or roles assigned to this issue/item

Returns:
a List of UserDto and/or RoleDto assigned to this issue/item, or null if not set

setAssignedTo

public void setAssignedTo(java.util.List<? extends NamedDto> assignedTo)
Set the users or roles assigned to this issue/item

Parameters:
assignedTo - is a List of UserDto and/or RoleDto to be assigned to this issue/item

getAssignedAt

public java.util.Date getAssignedAt()
Get the last date and time when the user/role assignment has changed

Returns:
last date and time when the user/role assignment has changed, or null if not set

setAssignedAt

public void setAssignedAt(java.util.Date assignedAt)
Set the last date and time when the user/role assignment has changed

Parameters:
assignedAt - is the date and time when the user/role assignment has changed

getSupervisors

public java.util.List<? extends NamedDto> getSupervisors()
Get the users or roles supervising this issue/item

Returns:
a List of UserDto and/or RoleDto supervising this issue/item, or null if not set

setSupervisors

public void setSupervisors(java.util.List<? extends NamedDto> supervisors)
Set the users or roles to supervise this issue/item

Parameters:
supervisors - is a List of UserDto and/or RoleDto to supervise this issue/item, or null

getNamedPriority

public NamedDto getNamedPriority()
Get the priority of this issue/item

Returns:
the item/issue priority, or null if not set

setNamedPriority

public void setNamedPriority(NamedDto priority)
Set the priority of this issue/item

Parameters:
priority - to set, or null

getPriority

public java.lang.Integer getPriority()
Old style priority getter to be backwards compatible. Get the naked priority id. To get the priority name, use getNamedPriority()

Returns:
naked priority id

setPriority

public void setPriority(java.lang.Integer prio)
Old style priority setter to be backwards compatible. Allows to set the priority of this issue/item via a naked Integer.

Parameters:
prio - is the naked priority id to set

getStatus

public NamedDto getStatus()
Get the status of this issue/item

Returns:
the current item/issue status, or null if not set

setStatus

public void setStatus(NamedDto status)
Set the status of this issue/item

Parameters:
status - to set

getCategories

public java.util.List<? extends NamedDto> getCategories()
Get the categories associated with this item/issue

Returns:
the List of categories associated with this item/issue, or null if not set

setCategories

public void setCategories(java.util.List<? extends NamedDto> categories)
Set the categories to be associated with this item/issue

Parameters:
categories - to be associated with this item/issue, or null

getSeverities

public java.util.List<? extends NamedDto> getSeverities()
Get the severities associated with this item/issue

Returns:
the List of item/issue severities, or null if not set

setSeverities

public void setSeverities(java.util.List<? extends NamedDto> severities)
Set the severities to be associated with this item/issue

Parameters:
severities - is a List of severities to be associated with this item/issue, or null

getMilestones

public java.util.List<? extends NamedDto> getMilestones()
Get the milestones associated with this item/issue

Returns:
the List of item/issue milestones, or null

setMilestones

public void setMilestones(java.util.List<? extends NamedDto> milestones)
Set the milestones to be associated with this item/issue

Parameters:
milestones - is a List of milestones to associate with this item/issue, or null

getPlatforms

public java.util.List<? extends NamedDto> getPlatforms()
Get the platforms associated with this item/issue

Returns:
a List of platforms associated with this item/issue, or null if not set

setPlatforms

public void setPlatforms(java.util.List<? extends NamedDto> platforms)
Set the platforms to be associated with this issue

Parameters:
platforms - is a List of platforms to associate with this issue, or null

getOses

public java.util.List<? extends NamedDto> getOses()
Get the operating systems associated with this issue/item

Returns:
a List of operating systems associated with this issue/item, or null if not set

setOses

public void setOses(java.util.List<? extends NamedDto> oses)
Set the operating systems to be associated with this issue

Parameters:
oses - is a List of operating systems to associate with this issue, or null

getResolutions

public java.util.List<? extends NamedDto> getResolutions()
Get the resolutions associated with this issue/item

Returns:
a List of resolutions associated with this issue/item, or null if not set

setResolutions

public void setResolutions(java.util.List<? extends NamedDto> resolutions)
Set the resolutions to be associated with this issue

Parameters:
resolutions - is a List of resolutions to associate with this issue, or null

getVersions

public java.util.List<? extends NamedDto> getVersions()
Get the versions associated with this issue/item

Returns:
a List of versions associated with this issue/item, or null if not set

setVersions

public void setVersions(java.util.List<? extends NamedDto> versions)
Set the versions to be associated with this issue

Parameters:
versions - is a List of versions to associate with this issue, or null

getChoiceList

public java.util.Map<java.lang.Integer,java.util.List<? extends NamedDto>> getChoiceList()
Get the Map of user defined choice lists: Key = choice index, Value = choice List

Returns:
the Map of user defined choice lists

getChoiceList

public java.util.List<? extends NamedDto> getChoiceList(int idx)
Get the idx.th user defined choice list

Parameters:
idx - of the user defined choice list to get [0 .. 8999]
Returns:
the value of the idx.th user defined choice List, or null if no such choice list exists

setChoiceList

public void setChoiceList(int idx,
                          java.util.List<? extends NamedDto> value)
Set the value of the idx.th user defined choice list

Parameters:
idx - of the user defined choice list to set [0 .. 8999]
value - to set

getChoiceField0s

public java.util.List<? extends NamedDto> getChoiceField0s()
Deprecated. use getChoiceList(0) instead


setChoiceField0s

public void setChoiceField0s(java.util.List<? extends NamedDto> value)
Deprecated. use setChoiceList(0, value) instead


getChoiceField1s

public java.util.List<? extends NamedDto> getChoiceField1s()
Deprecated. use getChoiceList(1) instead


setChoiceField1s

public void setChoiceField1s(java.util.List<? extends NamedDto> value)
Deprecated. use setChoiceList(1, value) instead


getChoiceField2s

public java.util.List<? extends NamedDto> getChoiceField2s()
Deprecated. use getChoiceList(2) instead


setChoiceField2s

public void setChoiceField2s(java.util.List<? extends NamedDto> value)
Deprecated. use setChoiceList(2, value) instead


getChoiceField3s

public java.util.List<? extends NamedDto> getChoiceField3s()
Deprecated. use getChoiceList(3) instead


setChoiceField3s

public void setChoiceField3s(java.util.List<? extends NamedDto> value)
Deprecated. use setChoiceList(3, value) instead


getStartDate

public java.util.Date getStartDate()
Get the intended/planned start date (and time) of this issue/item

Returns:
the intended/planned start date (and time), or null if not set

setStartDate

public void setStartDate(java.util.Date startDate)
Set the intended/planned start date (and time) of this issue/item

Parameters:
startDate - is the intended/planned start date (and time), or null

getEndDate

public java.util.Date getEndDate()
Get the intended/planned end date (and time) of this issue/item

Returns:
the intended/planned end date (and time), or null if not set

setEndDate

public void setEndDate(java.util.Date endDate)
Set the intended/planned end date (and time) of this issue/item

Parameters:
endDate - is the intended/planned end date (and time), or null

getClosedAt

public java.util.Date getClosedAt()
Get the actual close/end date of this issue/item

Returns:
the actual close/end date (and time) of this issue/item, or null if not closed yet

setClosedAt

public void setClosedAt(java.util.Date closedAt)
Set the actual close/end date of this issue/item

Parameters:
closedAt - is the actual close/end date (and time), or null

isClosed

public boolean isClosed()
TODO: This method depends on implicit assumptions and should be removed or refactored Check whether this item/issue is closed or not.

Returns:
true if the item/issue is closed, otherwise false

getEstimatedHours

public java.lang.Double getEstimatedHours()
Get the estimated effort to resolve this issue/item in hours

Returns:
the estimated effort to resolve this issue/item in hours, or null if not set

setEstimatedHours

public void setEstimatedHours(java.lang.Double estimatedHours)
Set the estimated effort to resolve this issue/item in hours

Parameters:
estimatedHours - is the estimated effort to resolve this issue/item in hours, or null

getSpentHours

public java.lang.Double getSpentHours()
Get the actual/accumulated effort spent on this issue/item in hours

Returns:
the actual/accumulated effort spent on this issue/item in hours, or null if not set

setSpentHours

public void setSpentHours(java.lang.Double spentHours)
Set the actual/accumulated effort spent on this issue/item in hours

Parameters:
spentHours - is the spent effort on this issue/item in hours, or null

getSpentEstimatedHours

public java.lang.Double getSpentEstimatedHours()
Get the ratio of spentHours/estimatedHours in percent

Returns:
the ratio of spentHours/estimatedHours in percent, or null if no estimated and/or spent hours are set

getShortDescription

public java.lang.String getShortDescription()
Get a short description of this item/issue. This is equivalent to NamedDto.getName()

Specified by:
getShortDescription in interface ReferableDto
Returns:
the name of this item/issue

getSummary

public java.lang.String getSummary()
Deprecated. Use NamedDto.getName() or getShortDescription() instead

Get a short description of this item/issue.

Returns:
the name of this item

setSummary

public void setSummary(java.lang.String summary)
Deprecated. Use NamedDto.setName(String) instead

Parameters:
summary - is the name of this item

getCustomField

public java.util.Map<java.lang.Integer,java.lang.String> getCustomField()
Get the Map of user defined field values: Key = field index, Value = field value

Returns:
the Map of user defined values

getCustomField

public java.lang.String getCustomField(int idx)
Get the idx.th user defined field value

Parameters:
idx - of the user defined field whose value to get [0 .. n]
Returns:
the value of the idx.th user defined field, or null if no such field or value exists

setCustomField

public void setCustomField(int idx,
                           java.lang.String value)
Set the value of the idx.th user defined field

Parameters:
idx - of the user defined field to set [0 .. n]
value - to set

getUndefined0

public java.lang.String getUndefined0()
Deprecated. use getCustomField(0) instead


setUndefined0

public void setUndefined0(java.lang.String value)
Deprecated. use setCustomField(0, value) instead


getUndefined1

public java.lang.String getUndefined1()
Deprecated. use getCustomField(1) instead


setUndefined1

public void setUndefined1(java.lang.String value)
Deprecated. use setCustomField(1, value) instead


getUndefined2

public java.lang.String getUndefined2()
Deprecated. use getCustomField(2) instead


setUndefined2

public void setUndefined2(java.lang.String value)
Deprecated. use setCustomField(2, value) instead


getUndefined3

public java.lang.String getUndefined3()
Deprecated. use getCustomField(3) instead


setUndefined3

public void setUndefined3(java.lang.String value)
Deprecated. use setCustomField(3, value) instead


getUndefined4

public java.lang.String getUndefined4()
Deprecated. use getCustomField(4) instead


setUndefined4

public void setUndefined4(java.lang.String value)
Deprecated. use setCustomField(4, value) instead


getUndefined5

public java.lang.String getUndefined5()
Deprecated. use getCustomField(5) instead


setUndefined5

public void setUndefined5(java.lang.String value)
Deprecated. use setCustomField(5, value) instead


getUndefined6

public java.lang.String getUndefined6()
Deprecated. use getCustomField(6) instead


setUndefined6

public void setUndefined6(java.lang.String value)
Deprecated. use setCustomField(6, value) instead


getUndefined7

public java.lang.String getUndefined7()
Deprecated. use getCustomField(7) instead


setUndefined7

public void setUndefined7(java.lang.String value)
Deprecated. use setCustomField(7, value) instead


getUndefined8

public java.lang.String getUndefined8()
Deprecated. use getCustomField(8) instead


setUndefined8

public void setUndefined8(java.lang.String value)
Deprecated. use setCustomField(8, value) instead


getUndefined9

public java.lang.String getUndefined9()
Deprecated. use getCustomField(9) instead


setUndefined9

public void setUndefined9(java.lang.String value)
Deprecated. use setCustomField(9, value) instead


getUndefined10

public java.lang.String getUndefined10()
Deprecated. use getCustomField(10) instead


setUndefined10

public void setUndefined10(java.lang.String value)
Deprecated. use setCustomField(10, value) instead


getUndefined11

public java.lang.String getUndefined11()
Deprecated. use getCustomField(11) instead


setUndefined11

public void setUndefined11(java.lang.String value)
Deprecated. use setCustomField(11, value) instead


getUndefined12

public java.lang.String getUndefined12()
Deprecated. use getCustomField(12) instead


setUndefined12

public void setUndefined12(java.lang.String value)
Deprecated. use setCustomField(12, value) instead


getUndefined13

public java.lang.String getUndefined13()
Deprecated. use getCustomField(13) instead


setUndefined13

public void setUndefined13(java.lang.String value)
Deprecated. use setCustomField(13, value) instead


getUndefined14

public java.lang.String getUndefined14()
Deprecated. use getCustomField(14) instead


setUndefined14

public void setUndefined14(java.lang.String value)
Deprecated. use setCustomField(14, value) instead


getUndefined15

public java.lang.String getUndefined15()
Deprecated. use getCustomField(15) instead


setUndefined15

public void setUndefined15(java.lang.String value)
Deprecated. use setCustomField(15, value) instead


getUndefined16

public java.lang.String getUndefined16()
Deprecated. use getCustomField(16) instead


setUndefined16

public void setUndefined16(java.lang.String value)
Deprecated. use setCustomField(16, value) instead


getUndefined17

public java.lang.String getUndefined17()
Deprecated. use getCustomField(17) instead


setUndefined17

public void setUndefined17(java.lang.String value)
Deprecated. use setCustomField(17, value) instead


getUndefined18

public java.lang.String getUndefined18()
Deprecated. use getCustomField(18) instead


setUndefined18

public void setUndefined18(java.lang.String value)
Deprecated. use setCustomField(18, value) instead


getUndefined19

public java.lang.String getUndefined19()
Deprecated. use getCustomField(19) instead


setUndefined19

public void setUndefined19(java.lang.String value)
Deprecated. use setCustomField(19, value) instead


getUndefined20

public java.lang.String getUndefined20()
Deprecated. use getCustomField(20) instead


setUndefined20

public void setUndefined20(java.lang.String value)
Deprecated. use setCustomField(20, value) instead


getUndefined21

public java.lang.String getUndefined21()
Deprecated. use getCustomField(21) instead


setUndefined21

public void setUndefined21(java.lang.String value)
Deprecated. use setCustomField(21, value) instead


getUndefined22

public java.lang.String getUndefined22()
Deprecated. use getCustomField(22) instead


setUndefined22

public void setUndefined22(java.lang.String value)
Deprecated. use setCustomField(22, value) instead


getUndefined23

public java.lang.String getUndefined23()
Deprecated. use getCustomField(23) instead


setUndefined23

public void setUndefined23(java.lang.String value)
Deprecated. use setCustomField(23, value) instead


getUndefined24

public java.lang.String getUndefined24()
Deprecated. use getCustomField(24) instead


setUndefined24

public void setUndefined24(java.lang.String value)
Deprecated. use setCustomField(24, value) instead


getUndefined25

public java.lang.String getUndefined25()
Deprecated. use getCustomField(25) instead


setUndefined25

public void setUndefined25(java.lang.String value)
Deprecated. use setCustomField(25, value) instead


getFileRevisionAtSubmit

public java.lang.String getFileRevisionAtSubmit()
Deprecated. 


setFileRevisionAtSubmit

public void setFileRevisionAtSubmit(java.lang.String fileRevisionAtSubmit)
Deprecated. 


getFileRevisionAtClose

public java.lang.String getFileRevisionAtClose()
Deprecated. 


setFileRevisionAtClose

public void setFileRevisionAtClose(java.lang.String fileRevisionAtClose)
Deprecated. 


getNoOfAttachments

public java.lang.Integer getNoOfAttachments()
Get the number of attachments associated with this item/issue

Returns:
number of issue/item attachments

setNoOfAttachments

public void setNoOfAttachments(java.lang.Integer noOfAttachments)
Set the number of attachments associated with this item/issue Note: Changes to this property are not persistent

Parameters:
noOfAttachments - available

getHasCommits

public java.lang.Boolean getHasCommits()
Check if any SCM commits are associated with this item/issue

Returns:
TRUE if SCM commits are associated with this item/issue, otherwise null or FALSE

setHasCommits

public void setHasCommits(java.lang.Boolean hasCommits)
Set whether any SCM commits are associated with this item/issue Note: Changes to this property are not persistent

Parameters:
hasCommits - TRUE if SCM commits are associated with this item/issue, otherwise FALSE

getScmCommits

public java.util.List<?> getScmCommits()
Deprecated. this information is no longer available here

Get the list of SCM commits associated with this item/issue

Returns:
null

setScmCommits

public void setScmCommits(java.util.List<?> scmCommits)
Deprecated. this information is no longer available here

Set the SCM commits associated with this item/issue Note: Changes to this property are not persistent


isWritable

public boolean isWritable()
Check whether this item/issue is writable/editable for the current user

Specified by:
isWritable in interface WriteControlledDto
Returns:
true if the current user can edit this item/issue, otherwise false

setWritable

public void setWritable(boolean editable)
Set whether this item/issue is writable/editable for the current user Note: Changes to this property are not persistent

Specified by:
setWritable in interface WriteControlledDto
Parameters:
editable - is true if the current user can edit this item/issue, otherwise false

isIndexed

public boolean isIndexed()
Check whether this item/issue has been indexed for search

Specified by:
isIndexed in interface IndexableDto
Returns:
true if item/issue has been indexed, otherwise false

setIndexed

public void setIndexed(boolean indexed)
Set whether this item/issue has been indexed for search Note: Changes to this property are not persistent

Specified by:
setIndexed in interface IndexableDto
Parameters:
indexed - is true if the item/issue has been indexed for search, otherwise false

isDeleted

public boolean isDeleted()
Check whether this item/issue has been (logically) deleted

Returns:
true if item/issue has been (logically) deleted, otherwise false

setDeleted

public void setDeleted(boolean deleted)
Set whether this item/issue has been (logically) deleted

Parameters:
deleted - true if item/issue has been (logically) deleted, otherwise false

isAggregated

public boolean isAggregated()
Check if this item contains aggregated child values (e.g. getEstimatedHours(), getSpentHours()

Returns:
true if this item contains aggregated child values, otherwise false

setAggregated

public void setAggregated(boolean aggregated)
Set whether this item contains own values or aggregated child values (e.g. getEstimatedHours(), getSpentHours()

Parameters:
aggregated - true if this item contains aggregated child values, false if the item contains own values

getKeyAndId

public java.lang.String getKeyAndId()

isConfigItem

public boolean isConfigItem()
Check whether this object represents a CMDB Configuration Item or a Tracker Item (issue)

Returns:
true if this object is a Configuration Item, otherwise false if the object is a Tracker Item (issue)

getTypeName

public java.lang.String getTypeName()
Get the type name of this item/issue

Returns:
"Configuration Item" for CMDB Configuration Items, "Issue" for Tracker Items/Issues

getUrlLink

public java.lang.String getUrlLink()
Description copied from interface: ReferableDto
Returns the local URL that points to the web page where this DTO is managed.

Specified by:
getUrlLink in interface ReferableDto

getInterwikiLink

public java.lang.String getInterwikiLink()
Description copied from interface: ReferableDto
Returns the interwiki link that points to the web page where this DTO is managed.

Specified by:
getInterwikiLink in interface ReferableDto

getIconUrl

public java.lang.String getIconUrl()
Description copied from interface: ReferableDto
Returns the URL of the (small) icon image that represents this DTO type.

Specified by:
getIconUrl in interface ReferableDto

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class NamedDto

hashCode

public int hashCode()
Overrides:
hashCode in class NamedDto

compareTo

public int compareTo(java.lang.Object obj)
Description copied from class: NamedDto
Caution: NamedDto compareTo violates the rule that a.equals(b) is equivalent to a.compareTo(b) == 0, because only the names are compared

Specified by:
compareTo in interface java.lang.Comparable
Overrides:
compareTo in class NamedDto

toString

public java.lang.String toString()
Overrides:
toString in class NamedDto

compareTrackerItems

public static int compareTrackerItems(TrackerItemDto i1,
                                      TrackerItemDto i2)
Compare two TrackerItems that may be null

Parameters:
i1 - is the first TrackerItem, or null
i2 - is the second TrackerItem, or null
Returns:
a value < 0 if i1 is less than i2, a value > 0 if i1 greater than i2, and 0 if i1 equals i2

CodeBeamer 5.4.0.1-RC API

Copyright © 2006-2009 Intland Software. All rights reserved.