com.liferay.portlet.ratings.model
Interface RatingsStatsModel

All Superinterfaces:

BaseModel<RatingsStats>, Cloneable, Comparable<RatingsStats>, Serializable

All Known Subinterfaces:

RatingsStats

All Known Implementing Classes:

RatingsStatsImpl, RatingsStatsModelImpl, RatingsStatsWrapper

public interface RatingsStatsModel
extends BaseModel<RatingsStats>

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

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

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

See Also:

RatingsStats, RatingsStatsImpl, RatingsStatsModelImpl

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(RatingsStats ratingsStats)
double	getAverageScore() Gets the average score of this ratings stats.
String	getClassName() Gets the class name of the model instance this ratings stats is polymorphically associated with.
long	getClassNameId() Gets the class name id of this ratings stats.
long	getClassPK() Gets the class p k of this ratings stats.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getPrimaryKey() Gets the primary key of this ratings stats.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getStatsId() Gets the stats id of this ratings stats.
int	getTotalEntries() Gets the total entries of this ratings stats.
double	getTotalScore() Gets the total score of this ratings stats.
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	setAverageScore(double averageScore) Sets the average score of this ratings stats.
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 stats.
void	setClassPK(long classPK) Sets the class p k of this ratings stats.
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	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 stats
void	setStatsId(long statsId) Sets the stats id of this ratings stats.
void	setTotalEntries(int totalEntries) Sets the total entries of this ratings stats.
void	setTotalScore(double totalScore) Sets the total score of this ratings stats.
RatingsStats	toEscapedModel() Gets a copy of this ratings stats 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 stats.

Returns:

the primary key of this ratings stats

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this ratings stats

Parameters:

pk - the primary key of this ratings stats

getStatsId

long getStatsId()

Gets the stats id of this ratings stats.

Returns:

the stats id of this ratings stats

setStatsId

void setStatsId(long statsId)

Sets the stats id of this ratings stats.

Parameters:

statsId - the stats id of this ratings stats

getClassName

String getClassName()

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

Returns:

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

getClassNameId

long getClassNameId()

Gets the class name id of this ratings stats.

Returns:

the class name id of this ratings stats

setClassNameId

void setClassNameId(long classNameId)

Sets the class name id of this ratings stats.

Parameters:

classNameId - the class name id of this ratings stats

getClassPK

long getClassPK()

Gets the class p k of this ratings stats.

Returns:

the class p k of this ratings stats

setClassPK

void setClassPK(long classPK)

Sets the class p k of this ratings stats.

Parameters:

classPK - the class p k of this ratings stats

getTotalEntries

int getTotalEntries()

Gets the total entries of this ratings stats.

Returns:

the total entries of this ratings stats

setTotalEntries

void setTotalEntries(int totalEntries)

Sets the total entries of this ratings stats.

Parameters:

totalEntries - the total entries of this ratings stats

getTotalScore

double getTotalScore()

Gets the total score of this ratings stats.

Returns:

the total score of this ratings stats

setTotalScore

void setTotalScore(double totalScore)

Sets the total score of this ratings stats.

Parameters:

totalScore - the total score of this ratings stats

getAverageScore

double getAverageScore()

Gets the average score of this ratings stats.

Returns:

the average score of this ratings stats

setAverageScore

void setAverageScore(double averageScore)

Sets the average score of this ratings stats.

Parameters:

averageScore - the average score of this ratings stats

toEscapedModel

RatingsStats toEscapedModel()

Gets a copy of this ratings stats 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<RatingsStats>

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<RatingsStats>

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<RatingsStats>

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<RatingsStats>

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<RatingsStats>

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<RatingsStats>

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<RatingsStats>

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<RatingsStats>

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<RatingsStats>

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<RatingsStats>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(RatingsStats ratingsStats)

Specified by:

compareTo in interface Comparable<RatingsStats>

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<RatingsStats>

Returns:

the XML representation of this model instance