com.communote.server.core.vo.user.note

Class UserNoteEntityTO

java.lang.Object

com.communote.server.core.vo.user.note.UserNoteEntityTO

All Implemented Interfaces:

Serializable

public class UserNoteEntityTO
extends Object
implements Serializable

The TO for a user note entity. When using it for updating the data do not forget to set the setUpdateRank(boolean) parameter

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserNoteEntityTO(Long userId, Long noteId)

Method Summary

Modifier and Type	Method and Description
double	getNormalizedRank()
Long	getNoteId()
Long	getUserId()
boolean	isUpdateRank()
void	setNormalizedRank(double normalizedRank)
void	setUpdateRank(boolean updateRank)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserNoteEntityTO

public UserNoteEntityTO(Long userId,
                        Long noteId)

Parameters:

userId - the associated user id - cannot be null

noteId - the associated note id - cannot be null

Method Detail

getNormalizedRank

public double getNormalizedRank()

Returns:

the normalized rank (a number between 0 and 1). the rank indicates a computed interest of the user into the note.

getNoteId

public Long getNoteId()

Returns:

the associated note id for this entity

getUserId

public Long getUserId()

Returns:

the associated user id for this entity

isUpdateRank

public boolean isUpdateRank()

Returns:

true if the rank should be updated when synchronizing with the backend

setNormalizedRank

public void setNormalizedRank(double normalizedRank)

Parameters:

normalizedRank - the normalized rank. if not a number between 0 and 1 it will be limited to 0 or 1

setUpdateRank

public void setUpdateRank(boolean updateRank)

Parameters:

updateRank - if true the rank will be updated if passed to the management layer