com.liferay.portlet.ratings.model
Interface RatingsEntryModel

All Superinterfaces:

BaseModel<RatingsEntry>, Cloneable, Comparable<RatingsEntry>, Serializable

All Known Subinterfaces:

RatingsEntry

All Known Implementing Classes:

RatingsEntryImpl, RatingsEntryModelImpl, RatingsEntryWrapper

public interface RatingsEntryModel
extends BaseModel<RatingsEntry>

The base model interface for the RatingsEntry service. Represents a row in the "RatingsEntry" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation RatingsEntryModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in RatingsEntryImpl.

Never modify or reference this interface directly. All methods that expect a ratings entry model instance should use the RatingsEntry interface instead.

See Also:

RatingsEntry, RatingsEntryImpl, RatingsEntryModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(RatingsEntry ratingsEntry)
String	getClassName() Gets the class name of the model instance this ratings entry is polymorphically associated with.
long	getClassNameId() Gets the class name id of this ratings entry.
long	getClassPK() Gets the class p k of this ratings entry.
long	getCompanyId() Gets the company id of this ratings entry.
Date	getCreateDate() Gets the create date of this ratings entry.
long	getEntryId() Gets the entry id of this ratings entry.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
Date	getModifiedDate() Gets the modified date of this ratings entry.
long	getPrimaryKey() Gets the primary key of this ratings entry.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
double	getScore() Gets the score of this ratings entry.
long	getUserId() Gets the user id of this ratings entry.
String	getUserName() Gets the user name of this ratings entry.
String	getUserUuid() Gets the user uuid of this ratings entry.
int	hashCode()
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isNew() Determines if this model instance does not yet exist in the database.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setClassNameId(long classNameId) Sets the class name id of this ratings entry.
void	setClassPK(long classPK) Sets the class p k of this ratings entry.
void	setCompanyId(long companyId) Sets the company id of this ratings entry.
void	setCreateDate(Date createDate) Sets the create date of this ratings entry.
void	setEntryId(long entryId) Sets the entry id of this ratings entry.
void	setEscapedModel(boolean escapedModel) Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this ratings entry.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(long pk) Sets the primary key of this ratings entry
void	setScore(double score) Sets the score of this ratings entry.
void	setUserId(long userId) Sets the user id of this ratings entry.
void	setUserName(String userName) Sets the user name of this ratings entry.
void	setUserUuid(String userUuid) Sets the user uuid of this ratings entry.
RatingsEntry	toEscapedModel() Gets a copy of this ratings entry as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this ratings entry.

Returns:

the primary key of this ratings entry

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this ratings entry

Parameters:

pk - the primary key of this ratings entry

getEntryId

long getEntryId()

Gets the entry id of this ratings entry.

Returns:

the entry id of this ratings entry

setEntryId

void setEntryId(long entryId)

Sets the entry id of this ratings entry.

Parameters:

entryId - the entry id of this ratings entry

getCompanyId

long getCompanyId()

Gets the company id of this ratings entry.

Returns:

the company id of this ratings entry

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this ratings entry.

Parameters:

companyId - the company id of this ratings entry

getUserId

long getUserId()

Gets the user id of this ratings entry.

Returns:

the user id of this ratings entry

setUserId

void setUserId(long userId)

Sets the user id of this ratings entry.

Parameters:

userId - the user id of this ratings entry

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this ratings entry.

Returns:

the user uuid of this ratings entry

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this ratings entry.

Parameters:

userUuid - the user uuid of this ratings entry

getUserName

@AutoEscape
String getUserName()

Gets the user name of this ratings entry.

Returns:

the user name of this ratings entry

setUserName

void setUserName(String userName)

Sets the user name of this ratings entry.

Parameters:

userName - the user name of this ratings entry

getCreateDate

Date getCreateDate()

Gets the create date of this ratings entry.

Returns:

the create date of this ratings entry

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this ratings entry.

Parameters:

createDate - the create date of this ratings entry

getModifiedDate

Date getModifiedDate()

Gets the modified date of this ratings entry.

Returns:

the modified date of this ratings entry

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this ratings entry.

Parameters:

modifiedDate - the modified date of this ratings entry

getClassName

String getClassName()

Gets the class name of the model instance this ratings entry is polymorphically associated with.

Returns:

the class name of the model instance this ratings entry is polymorphically associated with

getClassNameId

long getClassNameId()

Gets the class name id of this ratings entry.

Returns:

the class name id of this ratings entry

setClassNameId

void setClassNameId(long classNameId)

Sets the class name id of this ratings entry.

Parameters:

classNameId - the class name id of this ratings entry

getClassPK

long getClassPK()

Gets the class p k of this ratings entry.

Returns:

the class p k of this ratings entry

setClassPK

void setClassPK(long classPK)

Sets the class p k of this ratings entry.

Parameters:

classPK - the class p k of this ratings entry

getScore

double getScore()

Gets the score of this ratings entry.

Returns:

the score of this ratings entry

setScore

void setScore(double score)

Sets the score of this ratings entry.

Parameters:

score - the score of this ratings entry

toEscapedModel

RatingsEntry toEscapedModel()

Gets a copy of this ratings entry as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

isNew

boolean isNew()

Description copied from interface: BaseModel

Determines if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<RatingsEntry>

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<RatingsEntry>

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()

Description copied from interface: BaseModel

Determines if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<RatingsEntry>

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<RatingsEntry>

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<RatingsEntry>

Returns:

true if this model instance is escaped; false otherwise

See Also:

BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)

Description copied from interface: BaseModel

Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:

setEscapedModel in interface BaseModel<RatingsEntry>

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<RatingsEntry>

Returns:

the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Gets the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<RatingsEntry>

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<RatingsEntry>

Parameters:

serviceContext - the service context to retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<RatingsEntry>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(RatingsEntry ratingsEntry)

Specified by:

compareTo in interface Comparable<RatingsEntry>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<RatingsEntry>

Returns:

the XML representation of this model instance