CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class ScmChangeSetDto

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.ScmChangeSetDto
All Implemented Interfaces:
BaseDto, IndexableDto, ProjectAwareDto, ReferableDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class ScmChangeSetDto
extends AbstractCommentDto
implements ProjectAwareDto, ReferableDto

A change set represents list of changed files committed at the same time.

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 INTERWIKI_LINK_TYPE
           
static java.lang.String SCM_REVISION_BASE_URL
           
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER
 
Constructor Summary
ScmChangeSetDto()
           
 
Method Summary
 java.lang.Object clone()
           
 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.util.Set<ScmChangeFileDto> getChangeFiles()
          Get the files affected by this change
 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 getMessage()
          Deprecated. use DescribeableDto.getDescription() instead
 ProjectDto getProject()
           
 java.lang.String getRepository()
          Get the SCM repository identifier
 java.lang.String getRevision()
          Get the resulting SCM repository revision
 java.lang.String getScmTask()
           
 java.lang.String getShortDescription()
          Returns the short description that represent this entity in the user interface.
 java.lang.String getState()
           
 java.lang.String getSubmitterName()
          Get the name of the repository user that submitted this change
 java.lang.String getTag()
           
 java.util.Set<TrackerItemDto> getTrackerItems()
          Get the issues affected by this change
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 void setChangeFiles(java.util.Set<ScmChangeFileDto> changeFiles)
          Set the files affected by this change
 void setProject(ProjectDto project)
           
 void setRepository(java.lang.String repository)
          Set the SCM repository identifier
 void setRevision(java.lang.String revision)
          Set the resulting SCM repository revision
 void setScmTask(java.lang.String sccTask)
           
 void setState(java.lang.String state)
           
 void setSubmitterName(java.lang.String userName)
          Set the name of the repository user that submitted this change
 void setTag(java.lang.String tag)
           
 void setTrackerItems(java.util.Set<TrackerItemDto> trackerItems)
          Set the issues affected by this change
 java.lang.String toString()
           
 
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
 
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

SCM_REVISION_BASE_URL

public static final java.lang.String SCM_REVISION_BASE_URL
See Also:
Constant Field Values
Constructor Detail

ScmChangeSetDto

public ScmChangeSetDto()
Method Detail

clone

public java.lang.Object clone()
Overrides:
clone in class IdentifiableDto

getProject

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

setProject

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

getSubmitterName

public java.lang.String getSubmitterName()
Get the name of the repository user that submitted this change

Returns:
the name of the repository user that submitted this change

setSubmitterName

public void setSubmitterName(java.lang.String userName)
Set the name of the repository user that submitted this change

Parameters:
userName - of the repository user that submitted this change

getMessage

public java.lang.String getMessage()
Deprecated. use DescribeableDto.getDescription() instead


getRepository

public java.lang.String getRepository()
Get the SCM repository identifier

Returns:
the SCM repository identifier

setRepository

public void setRepository(java.lang.String repository)
Set the SCM repository identifier

Parameters:
repository - is the SCM repository identifier

getRevision

public java.lang.String getRevision()
Get the resulting SCM repository revision

Returns:
the resulting SCM repository revision

setRevision

public void setRevision(java.lang.String revision)
Set the resulting SCM repository revision

Parameters:
revision - resulting from this change

getTag

public java.lang.String getTag()

setTag

public void setTag(java.lang.String tag)

getState

public java.lang.String getState()

setState

public void setState(java.lang.String state)

getScmTask

public java.lang.String getScmTask()

setScmTask

public void setScmTask(java.lang.String sccTask)

getChangeFiles

public java.util.Set<ScmChangeFileDto> getChangeFiles()
Get the files affected by this change

Returns:
a (sorted) Set of affected files

setChangeFiles

public void setChangeFiles(java.util.Set<ScmChangeFileDto> changeFiles)
Set the files affected by this change

Parameters:
changeFiles - is a (sorted) Set of affected files

getTrackerItems

public java.util.Set<TrackerItemDto> getTrackerItems()
Get the issues affected by this change

Returns:
a Set of affected issues, or null if none are affected

setTrackerItems

public void setTrackerItems(java.util.Set<TrackerItemDto> trackerItems)
Set the issues affected by this change

Parameters:
trackerItems - are the affected issues, or null if none are affected

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

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

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

toString

public java.lang.String toString()
Overrides:
toString 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 AbstractCommentDto

CodeBeamer 5.4.0.1-RC API

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