CodeBeamer 5.4.0.1-RC API

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

java.lang.Object
  extended by com.intland.codebeamer.persistence.dto.base.IdentifiableDto
      extended by com.intland.codebeamer.persistence.dto.base.ReferenceDto
All Implemented Interfaces:
BaseDto, ReferableDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
Direct Known Subclasses:
EntityLabelDto, NavigationHistoryDto, ObjectRatingDto, ObjectRatingStatsDto

public class ReferenceDto
extends IdentifiableDto
implements ReferableDto

A ReferenceDto represents a reference to a ReferableDto.

See Also:
Serialized Form

Nested Class Summary
 
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
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER
 
Constructor Summary
ReferenceDto()
           
ReferenceDto(java.lang.Integer typeId, java.lang.Integer id)
          Create a reference to the object with the specified type and id
ReferenceDto(ReferableDto dto)
          Create a reference to the specified ReferableDto
ReferenceDto(ReferenceDto reference)
          Create a shallow copy of the specified reference
 
Method Summary
 int compareTo(java.lang.Object obj)
           
 boolean equals(java.lang.Object obj)
           
 ReferableDto getDto()
          Get the referenced ReferableDto instance
 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 getShortDescription()
          Returns the short description that represent this entity in the user interface.
 java.lang.Integer getTypeId()
          Get the GroupType discriminator of the referenced object
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 int hashCode()
           
 void setDto(ReferableDto dto)
          Set the referenced ReferableDto instance
 void setTypeId(java.lang.Integer typeId)
          Set the GroupType of the referenced object
 java.lang.String 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

ReferenceDto

public ReferenceDto()

ReferenceDto

public ReferenceDto(java.lang.Integer typeId,
                    java.lang.Integer id)
Create a reference to the object with the specified type and id

Parameters:
typeId - is the GroupType of the referenced object
id - is the id of the referenced object

ReferenceDto

public ReferenceDto(ReferableDto dto)
Create a reference to the specified ReferableDto

Parameters:
dto - is the ReferableDto instance to refer to

ReferenceDto

public ReferenceDto(ReferenceDto reference)
Create a shallow copy of the specified reference

Parameters:
reference - to copy
Method Detail

getTypeId

public java.lang.Integer getTypeId()
Get the GroupType discriminator of the referenced object

Returns:
the type of the referenced object

setTypeId

public void setTypeId(java.lang.Integer typeId)
Set the GroupType of the referenced object

Parameters:
typeId - is the type discriminator of the referenced object

getDto

public ReferableDto getDto()
Get the referenced ReferableDto instance

Returns:
the referenced object instance, or null if not resolved

setDto

public void setDto(ReferableDto dto)
Set the referenced ReferableDto instance

Parameters:
dto - is the referenced object instance, or null

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

compareTo

public int compareTo(java.lang.Object obj)
Specified by:
compareTo in interface java.lang.Comparable
Overrides:
compareTo in class IdentifiableDto

equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class IdentifiableDto

toString

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

CodeBeamer 5.4.0.1-RC API

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