CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class ObjectRatingStatsDto

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

public class ObjectRatingStatsDto
extends ReferenceDto

DTO object holding rating or voting statistics for an Object.

See Also:
ObjectRatingDto, 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
ObjectRatingStatsDto()
           
 
Method Summary
 double getAverageRating()
          Calculate the average rating.
 java.lang.Integer getEntityId()
          Deprecated. use getId() instead
 java.lang.Integer getEntityTypeId()
          Deprecated. use getTypeId() instead
 long getNumberOfRatings()
           
 long getRatingTotal()
           
 java.lang.Object getReferencedObject()
          Deprecated. use getDto() instead
 void setNumberOfRatings(long numberOfRatings)
           
 void setRatingTotal(long totalRating)
           
 java.lang.String toString()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.ReferenceDto
compareTo, equals, getDto, getIconUrl, getInterwikiLink, getShortDescription, getTypeId, getUrlLink, hashCode, setDto, setTypeId
 
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

ObjectRatingStatsDto

public ObjectRatingStatsDto()
Method Detail

getEntityTypeId

public java.lang.Integer getEntityTypeId()
Deprecated. use getTypeId() instead


getEntityId

public java.lang.Integer getEntityId()
Deprecated. use getId() instead


getReferencedObject

public java.lang.Object getReferencedObject()
Deprecated. use getDto() instead


getNumberOfRatings

public long getNumberOfRatings()

setNumberOfRatings

public void setNumberOfRatings(long numberOfRatings)

getRatingTotal

public long getRatingTotal()

setRatingTotal

public void setRatingTotal(long totalRating)

getAverageRating

public double getAverageRating()
Calculate the average rating. The average is rounded to 1 digits.

Returns:
The average value

toString

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

CodeBeamer 5.4.0.1-RC API

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