CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class TrackerItemCommentDto

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.base.AbstractCommentDto
                  extended by com.intland.codebeamer.persistence.dto.TrackerItemCommentDto
All Implemented Interfaces:
BaseDto, IndexableDto, ProjectAwareDto, ReferableDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
Direct Known Subclasses:
TrackerItemAttachmentDto

public class TrackerItemCommentDto
extends AbstractCommentDto
implements ProjectAwareDto, ReferableDto

Wraps a tracker item comment.

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 URL_RESOURCE_PREFIX
          URL prefix for tracker item comments.
static int VISIBLE_TO_COMMENT_SUBMITTER
          This comment should be visible for the comment owner/submitter
static int VISIBLE_TO_ISSUE_ASSIGNEES
          This comment should be visible for the users assigned to the issue
static int VISIBLE_TO_ISSUE_SUBMITTER
          This comment should be visible for the issue submitter
static int VISIBLE_TO_ISSUE_SUPERVISORS
          This comment should be visible for the users supervising to the issue
static int VISIBLE_TO_SPECIFIC_ROLE
          This comment should be visible for project members in the specified role
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER
 
Constructor Summary
TrackerItemCommentDto()
           
 
Method Summary
 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
 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.
 ProjectDto getProject()
           
 java.lang.Integer getResponseToId()
          Get the ID of the comment (to the same tracker item) this is a response to
 java.lang.String getRestfulUrlLink()
          FIXME This is temporary! In 5.5.
 RoleDto getRole()
          Get the role of project members that have permission to see this comment, additionally to others defined by getVisibility()
 java.lang.String getShortDescription()
          Returns the short description that represent this entity in the user interface.
 TrackerItemDto getTrackerItem()
           
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 java.lang.Integer getVisibility()
          Get the special visibility of this comment, or null, if visibility is the same as trackerItem visibility.
 boolean isVisible(int bits)
          Check if all of the specified bits are set in the visibility mask
 void setProject(ProjectDto project)
           
 void setResponseToId(java.lang.Integer responseToId)
          Set the ID of the comment (to the same tracker item) this is a response to
 void setRole(RoleDto role)
          Set the role of project members that have permission to see this comment.
 void setTrackerItem(TrackerItemDto trackerItem)
           
 void setVisibility(java.lang.Integer visibility)
          Set the special visibility of this comment.
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.AbstractCommentDto
compareDates, equals, getSubmittedAt, getSubmitter, isIndexed, setIndexed, setSubmittedAt, setSubmitter
 
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, hashCode, setName, toString
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
clone, compare, compareInteger, equals, getId, hashCode, setId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

URL_RESOURCE_PREFIX

public static final java.lang.String URL_RESOURCE_PREFIX
URL prefix for tracker item comments.

See Also:
Constant Field Values

VISIBLE_TO_COMMENT_SUBMITTER

public static final int VISIBLE_TO_COMMENT_SUBMITTER
This comment should be visible for the comment owner/submitter

See Also:
Constant Field Values

VISIBLE_TO_ISSUE_SUBMITTER

public static final int VISIBLE_TO_ISSUE_SUBMITTER
This comment should be visible for the issue submitter

See Also:
Constant Field Values

VISIBLE_TO_ISSUE_ASSIGNEES

public static final int VISIBLE_TO_ISSUE_ASSIGNEES
This comment should be visible for the users assigned to the issue

See Also:
Constant Field Values

VISIBLE_TO_ISSUE_SUPERVISORS

public static final int VISIBLE_TO_ISSUE_SUPERVISORS
This comment should be visible for the users supervising to the issue

See Also:
Constant Field Values

VISIBLE_TO_SPECIFIC_ROLE

public static final int VISIBLE_TO_SPECIFIC_ROLE
This comment should be visible for project members in the specified role

See Also:
Constant Field Values
Constructor Detail

TrackerItemCommentDto

public TrackerItemCommentDto()
Method Detail

getTrackerItem

public TrackerItemDto getTrackerItem()

setTrackerItem

public void setTrackerItem(TrackerItemDto trackerItem)

getResponseToId

public java.lang.Integer getResponseToId()
Get the ID of the comment (to the same tracker item) this is a response to

Returns:
the ID of the comment (to the same tracker item) this is a response to

setResponseToId

public void setResponseToId(java.lang.Integer responseToId)
Set the ID of the comment (to the same tracker item) this is a response to

Parameters:
responseToId - is the ID of the comment (to the same tracker item) this is a response to

getVisibility

public java.lang.Integer getVisibility()
Get the special visibility of this comment, or null, if visibility is the same as trackerItem visibility. This is a bitmask (logical OR) of
- VISIBLE_TO_COMMENT_SUBMITTER
- VISIBLE_TO_ISSUE_SUBMITTER
- VISIBLE_TO_ISSUE_ASSIGNEES
- VISIBLE_TO_ISSUE_SUPERVISORS
- VISIBLE_TO_SPECIFIC_ROLE defined in getRole()

Returns:
the special visibility of this comment

setVisibility

public void setVisibility(java.lang.Integer visibility)
Set the special visibility of this comment. This should be null, to set visibility the same as the trackerItem, or a bitmask (logical OR) of
- VISIBLE_TO_COMMENT_SUBMITTER
- VISIBLE_TO_ISSUE_SUBMITTER
- VISIBLE_TO_ISSUE_ASSIGNEES
- VISIBLE_TO_ISSUE_SUPERVISORS
- VISIBLE_TO_SPECIFIC_ROLE defined in getRole()

Parameters:
visibility - is the special visibility of this comment, or null

isVisible

public boolean isVisible(int bits)
Check if all of the specified bits are set in the visibility mask

Returns:
true if all bits are set, otherwise false

getRole

public RoleDto getRole()
Get the role of project members that have permission to see this comment, additionally to others defined by getVisibility()

Returns:
the role of project members that have permission to see this comment

setRole

public void setRole(RoleDto role)
Set the role of project members that have permission to see this comment. This role will only be used, if the option VISIBLE_TO_SPECIFIC_ROLE is included in the bitmask passed to setVisibility(Integer)

Parameters:
role - of project members that have permission to see this comment

getProject

public ProjectDto getProject()
Specified by:
getProject in interface ProjectAwareDto

setProject

public void setProject(ProjectDto project)
Specified by:
setProject in interface ProjectAwareDto

getShortDescription

public java.lang.String getShortDescription()
Description copied from interface: ReferableDto
Returns the short description that represent this entity in the user interface. This normally delegates to another getter, like ProjectDto.getName() or TrackerItemDto.getSummary().

Specified by:
getShortDescription in interface ReferableDto

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

getRestfulUrlLink

public java.lang.String getRestfulUrlLink()
FIXME This is temporary! In 5.5. rename this method to replace getUrlLink(), but in 5.4 we keep the original version for safety reason (no modifications right before the roll out!).


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

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 AbstractCommentDto

CodeBeamer 5.4.0.1-RC API

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