CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class TrackerDto

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.TrackerDto
All Implemented Interfaces:
BaseDto, ProjectAwareDto, ReferableDto, WriteControlledDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
Direct Known Subclasses:
ReadOnlyTrackerDto

public class TrackerDto
extends DescribeableDto
implements ProjectAwareDto, ReferableDto, WriteControlledDto

Wraps a tracker.

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 int BUG
           
static java.lang.String CATEGORY_LINK_TYPE
           
static int CHANGE
           
static int GENERAL
           
static java.lang.String INTERWIKI_LINK_TYPE
           
static int QA
           
static int REQUIREMENTS
           
static int TASK
           
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER
 
Constructor Summary
TrackerDto()
           
TrackerDto(java.lang.Integer id, java.lang.String name)
           
TrackerDto(TrackerDto tracker)
          Tracker copy constructor
 
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
static int compareTrackers(TrackerDto t1, TrackerDto t2)
          Compare two TrackerDtos that may be null
 boolean equals(java.lang.Object obj)
           
 java.util.Date getCreatedAt()
          Get the date and time the tracker was created
 UserDto getCreatedBy()
          Get the user that created the tracker
 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 getItemName()
          Get type name for items in this Tracker.
 java.lang.String getKeyName()
          Get the short/key name of the tracker
 java.lang.Integer getOldAfterDays()
           
 java.lang.Integer getProcessDefinitionId()
          Get the underlying value used by isUsingWorkflow()
 ProjectDto getProject()
          Get the project the tracker belongs to
 java.lang.String getShortDescription()
          Get a short tracker description.
 java.lang.Integer getTemplateId()
          Get the ID of the configuration template tracker
 java.lang.String getTrackerTypeName()
          Get the type name of this tracker
 TrackerTypeDto getType()
          Get the type of the tracker
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 java.lang.Boolean getVisible()
          Check if the tracker is visible
 boolean isCategory()
          Check whether this TrackerDto is a Configuration Item Category or an Issue Tracker
 boolean isReadable()
          Access control flag: Can the current user see this tracker
 boolean isUsingWorkflow()
          Check if workflow is active for this tracker
 boolean isWritable()
          Access control flag: Can the current user edit this tracker
 void setCreatedAt(java.util.Date createdAt)
          Set the date and time the tracker was created
 void setCreatedBy(UserDto createdByUser)
          Set the user that created the tracker
 void setKeyName(java.lang.String shortName)
          Set the short/key name of the tracker
 void setOldAfterDays(java.lang.Integer oldAfterDays)
           
 void setProcessDefinitionId(java.lang.Integer processDefinitionId)
          Deprecated. replaced by setUsingWorkflow(boolean)
 void setProject(ProjectDto project)
          Set the project the tracker belongs to
 void setReadable(boolean readable)
          Access control flag: Can the current user see this tracker Note: This property is not persistent
 void setTemplateId(java.lang.Integer templateId)
          Set the ID of the configuration template tracker
 void setType(TrackerTypeDto type)
          Set the type of the tracker
 void setUsingWorkflow(boolean workflowActive)
          Set whether to use workflow for this tracker or not
 void setVisible(java.lang.Boolean visible)
          Set whether the tracker is visible
 void setWritable(boolean writable)
          Access control flag: Can the current user edit this tracker Note: This property is not persistent
 java.lang.String toString()
          Get a description string of the form "<trackerTypeName> <project.name> - <name> [<keyName>:<id>]"
 
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
clone, 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

CATEGORY_LINK_TYPE

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

GENERAL

public static final int GENERAL
See Also:
Constant Field Values

BUG

public static final int BUG
See Also:
Constant Field Values

CHANGE

public static final int CHANGE
See Also:
Constant Field Values

QA

public static final int QA
See Also:
Constant Field Values

REQUIREMENTS

public static final int REQUIREMENTS
See Also:
Constant Field Values

TASK

public static final int TASK
See Also:
Constant Field Values
Constructor Detail

TrackerDto

public TrackerDto()

TrackerDto

public TrackerDto(java.lang.Integer id,
                  java.lang.String name)

TrackerDto

public TrackerDto(TrackerDto tracker)
Tracker copy constructor

Parameters:
tracker - to copy
Method Detail

getProject

public ProjectDto getProject()
Get the project the tracker belongs to

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

setProject

public void setProject(ProjectDto project)
Set the project the tracker belongs to

Specified by:
setProject in interface ProjectAwareDto
Parameters:
project - of the tracker (must not be null)

getType

public TrackerTypeDto getType()
Get the type of the tracker

Returns:
the tracker's type

setType

public void setType(TrackerTypeDto type)
Set the type of the tracker

Parameters:
type - of the tracker to set (must not be null)

isCategory

public boolean isCategory()
Check whether this TrackerDto is a Configuration Item Category or an Issue Tracker

Returns:
true if the TrackerDto is a Configuration Item Category, false for an Issue Tracker

getTrackerTypeName

public java.lang.String getTrackerTypeName()
Get the type name of this tracker

Returns:
"Category" for a CMDB category, "Tracker" for an issue tracker

getKeyName

public java.lang.String getKeyName()
Get the short/key name of the tracker

Returns:
the tracker's short/key name

setKeyName

public void setKeyName(java.lang.String shortName)
Set the short/key name of the tracker

Parameters:
shortName - for the tracker (must not be null)

getShortDescription

public java.lang.String getShortDescription()
Get a short tracker description. This is equivalent to NamedDto.getName()

Specified by:
getShortDescription in interface ReferableDto
Returns:
the tracker name

getItemName

public java.lang.String getItemName()
Get type name for items in this Tracker.

Returns:
"Configuration Item" for items in a CMDB category, "Issue" for tracker items

getCreatedAt

public java.util.Date getCreatedAt()
Get the date and time the tracker was created

Returns:
the tracker's creation date (and time)

setCreatedAt

public void setCreatedAt(java.util.Date createdAt)
Set the date and time the tracker was created

Parameters:
createdAt - is the date and time the tracker was created (must not be null)

getCreatedBy

public UserDto getCreatedBy()
Get the user that created the tracker

Returns:
the user that created the tracker

setCreatedBy

public void setCreatedBy(UserDto createdByUser)
Set the user that created the tracker

Parameters:
createdByUser - is the user that created the tracker (must not be null)

getTemplateId

public java.lang.Integer getTemplateId()
Get the ID of the configuration template tracker

Returns:
the ID of the template tracker, or null (no configuration template)

setTemplateId

public void setTemplateId(java.lang.Integer templateId)
Set the ID of the configuration template tracker

Parameters:
templateId - of the template tracker, or null (no configuration template)

getVisible

public java.lang.Boolean getVisible()
Check if the tracker is visible

Returns:
TRUE if the tracker is visible, otherwise null or FALSE

setVisible

public void setVisible(java.lang.Boolean visible)
Set whether the tracker is visible

Parameters:
visible - should be TRUE to make the tracker visible, otherwise null or FALSE

isUsingWorkflow

public boolean isUsingWorkflow()
Check if workflow is active for this tracker

Returns:
true if workflow is active, otherwise false

setUsingWorkflow

public void setUsingWorkflow(boolean workflowActive)
Set whether to use workflow for this tracker or not

Parameters:
workflowActive - is true to activate workflow, false to deactivate workflow

getProcessDefinitionId

public java.lang.Integer getProcessDefinitionId()
Get the underlying value used by isUsingWorkflow()


setProcessDefinitionId

public void setProcessDefinitionId(java.lang.Integer processDefinitionId)
Deprecated. replaced by setUsingWorkflow(boolean)


getOldAfterDays

public java.lang.Integer getOldAfterDays()

setOldAfterDays

public void setOldAfterDays(java.lang.Integer oldAfterDays)

isReadable

public boolean isReadable()
Access control flag: Can the current user see this tracker

Returns:
true if the current user can see this tracker

setReadable

public void setReadable(boolean readable)
Access control flag: Can the current user see this tracker Note: This property is not persistent

Parameters:
readable - true if the current user can see this tracker, otherwise false

isWritable

public boolean isWritable()
Access control flag: Can the current user edit this tracker

Specified by:
isWritable in interface WriteControlledDto
Returns:
true if the current user may edit this tracker

setWritable

public void setWritable(boolean writable)
Access control flag: Can the current user edit this tracker Note: This property is not persistent

Specified by:
setWritable in interface WriteControlledDto
Parameters:
writable - true if the current user may edit this tracker, otherwise false

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

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()
Get a description string of the form "<trackerTypeName> <project.name> - <name> [<keyName>:<id>]"

Overrides:
toString in class NamedDto

compareTrackers

public static int compareTrackers(TrackerDto t1,
                                  TrackerDto t2)
Compare two TrackerDtos that may be null

Parameters:
t1 - is the first TrackerDto, or null
t2 - is the second TrackerDto, or null
Returns:
a value < 0 if t1 is less than t2, a value > 0 if t1 greater than t2, and 0 if t1 equals t2

CodeBeamer 5.4.0.1-RC API

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