CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto.base
Class DescribeableDto

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
All Implemented Interfaces:
BaseDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
Direct Known Subclasses:
AbstractCommentDto, ArtifactDto, AssociationTypeDto, BuildDto, ForumDto, PermissionDto, ProjectDto, RoleDto, TrackerDto, TrackerItemDto, WorkingSetDto

public abstract class DescribeableDto
extends NamedDto

All named DTO classes with description property must extend this.

See Also:
Serialized Form

Nested Class Summary
static class DescribeableDto.DescriptionComparator
          A special Comparator to compare/sort DescribeableDto by description
 
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
 
Constructor Summary
DescribeableDto()
          Default constructor
DescribeableDto(DescribeableDto dto)
          DescribeableDto copy constructor
DescribeableDto(java.lang.Integer id, java.lang.String name, java.lang.String description, java.lang.String format)
          Create a new DescribeableDto with id, name and description
DescribeableDto(NamedDto named, java.lang.String description, java.lang.String format)
          Create a new DescribeableDto from a NamedDto plus description
 
Method Summary
static int compareByDescription(DescribeableDto dto1, DescribeableDto dto2)
           
 java.lang.String getDescription()
          Get the description text
 java.lang.String getDescriptionFormat()
          Get the description format @see DescriptionFormat
 void setDescription(java.lang.String details)
          Set the description text
 void setDescriptionFormat(java.lang.String descriptionFormat)
          Set the description format @see DescriptionFormat
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto
compareNames, compareString, compareStringIgnoreCase, compareTo, createLookupMap, equals, 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
 

Constructor Detail

DescribeableDto

public DescribeableDto()
Default constructor


DescribeableDto

public DescribeableDto(java.lang.Integer id,
                       java.lang.String name,
                       java.lang.String description,
                       java.lang.String format)
Create a new DescribeableDto with id, name and description

Parameters:
id - of the Dto
name - of the Dto
description - of the Dto
format - of the Dto description @see DescriptionFormat

DescribeableDto

public DescribeableDto(NamedDto named,
                       java.lang.String description,
                       java.lang.String format)
Create a new DescribeableDto from a NamedDto plus description

Parameters:
named - Dto to describe
description - of the Dto
format - of the Dto description @see DescriptionFormat

DescribeableDto

public DescribeableDto(DescribeableDto dto)
DescribeableDto copy constructor

Parameters:
dto - to copy
Method Detail

getDescription

public java.lang.String getDescription()
Get the description text

Returns:
the description text

setDescription

public void setDescription(java.lang.String details)
Set the description text

Parameters:
details - the description text

getDescriptionFormat

public java.lang.String getDescriptionFormat()
Get the description format @see DescriptionFormat

Returns:
the description format

setDescriptionFormat

public void setDescriptionFormat(java.lang.String descriptionFormat)
Set the description format @see DescriptionFormat

Parameters:
descriptionFormat - to set

compareByDescription

public static int compareByDescription(DescribeableDto dto1,
                                       DescribeableDto dto2)

CodeBeamer 5.4.0.1-RC API

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