CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class ObjectRatingDto

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

public class ObjectRatingDto
extends ReferenceDto

DTO object for storing/transferring rating or voting value made by an user. For most objects that is a rating value, between 1 and 5, but for TrackerItemDto-s that will be a voting value of -1 for "No" and +1 for "Yes" values.

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
ObjectRatingDto()
          Default constructor.
ObjectRatingDto(java.lang.Integer entityTypeId, java.lang.Integer entityId, UserDto user, java.lang.Integer rating)
          Convenience constructor.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.Integer getEntityId()
          Deprecated. use getId() instead
 java.lang.Integer getEntityTypeId()
          Deprecated. use getTypeId() instead
 java.lang.Integer getRate()
          The rating or voting value submitted by the user.
 java.util.Date getSubmittedAt()
          When was this rating submitted?
 UserDto getSubmitter()
          The user who has submitted this rating.
 int hashCode()
          HashCode and Equals check entityTypeId, entityId and submitter for equality.
 void setRate(java.lang.Integer rate)
           
 void setSubmittedAt(java.util.Date submittedAt)
           
 void setSubmitter(UserDto submitter)
           
 java.lang.String toString()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.ReferenceDto
compareTo, getDto, getIconUrl, getInterwikiLink, getShortDescription, getTypeId, getUrlLink, 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

ObjectRatingDto

public ObjectRatingDto()
Default constructor.


ObjectRatingDto

public ObjectRatingDto(java.lang.Integer entityTypeId,
                       java.lang.Integer entityId,
                       UserDto user,
                       java.lang.Integer rating)
Convenience constructor.

Parameters:
entityTypeId -
entityId -
user -
rating -
Method Detail

getEntityTypeId

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


getEntityId

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


getSubmitter

public UserDto getSubmitter()
The user who has submitted this rating.

Returns:
The user

setSubmitter

public void setSubmitter(UserDto submitter)

getRate

public java.lang.Integer getRate()
The rating or voting value submitted by the user. For most objects that is a rating value, between 1 and 5, but for TrackerItemDto-s that will be a voting value of -1 for "No" and +1 for "Yes" values.

Returns:
The current rate value

setRate

public void setRate(java.lang.Integer rate)

getSubmittedAt

public java.util.Date getSubmittedAt()
When was this rating submitted?

Returns:
The date-time when rating was submitted

setSubmittedAt

public void setSubmittedAt(java.util.Date submittedAt)

toString

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

hashCode

public int hashCode()
HashCode and Equals check entityTypeId, entityId and submitter for equality.

Overrides:
hashCode in class ReferenceDto
See Also:
Object.hashCode()

equals

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

CodeBeamer 5.4.0.1-RC API

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