com.liferay.ratings.kernel.model

Interface RatingsStatsModel

All Superinterfaces:

AttachedModel, BaseModel<RatingsStats>, ClassedModel, Cloneable, Comparable<RatingsStats>, Serializable, ShardedModel, TypedModel

All Known Subinterfaces:

RatingsStats

All Known Implementing Classes:

RatingsStatsWrapper

@ProviderType
public interface RatingsStatsModel
extends AttachedModel, BaseModel<RatingsStats>, ShardedModel

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.

Author:

Brian Wing Shun Chan

See Also:

RatingsStats, RatingsStatsImpl, RatingsStatsModelImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a shallow clone of this model instance.
int	compareTo(RatingsStats ratingsStats)
double	getAverageScore() Returns the average score of this ratings stats.
String	getClassName() Returns the fully qualified class name of this ratings stats.
long	getClassNameId() Returns the class name ID of this ratings stats.
long	getClassPK() Returns the class pk of this ratings stats.
long	getCompanyId() Returns the company ID of this ratings stats.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getPrimaryKey() Returns the primary key of this ratings stats.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
long	getStatsId() Returns the stats ID of this ratings stats.
int	getTotalEntries() Returns the total entries of this ratings stats.
double	getTotalScore() Returns the total score of this ratings stats.
int	hashCode()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isNew() Returns true 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	setClassName(String className)
void	setClassNameId(long classNameId) Sets the class name ID of this ratings stats.
void	setClassPK(long classPK) Sets the class pk of this ratings stats.
void	setCompanyId(long companyId) Sets the company ID of this ratings stats.
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
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 primaryKey) Sets the primary key of this ratings stats.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
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.
CacheModel<RatingsStats>	toCacheModel() Returns a cache model object for this entity used by entity cache.
RatingsStats	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
RatingsStats	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this ratings stats.

Returns:

the primary key of this ratings stats

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this ratings stats.

Parameters:

primaryKey - the primary key of this ratings stats

getStatsId

long getStatsId()

Returns 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

getCompanyId

long getCompanyId()

Returns the company ID of this ratings stats.

Specified by:

getCompanyId in interface ShardedModel

Returns:

the company ID of this ratings stats

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this ratings stats.

Specified by:

setCompanyId in interface ShardedModel

Parameters:

companyId - the company ID of this ratings stats

getClassName

String getClassName()

Returns the fully qualified class name of this ratings stats.

Specified by:

getClassName in interface TypedModel

Returns:

the fully qualified class name of this ratings stats

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()

Returns the class name ID of this ratings stats.

Specified by:

getClassNameId in interface TypedModel

Returns:

the class name ID of this ratings stats

setClassNameId

void setClassNameId(long classNameId)

Sets the class name ID of this ratings stats.

Specified by:

setClassNameId in interface TypedModel

Parameters:

classNameId - the class name ID of this ratings stats

getClassPK

long getClassPK()

Returns the class pk of this ratings stats.

Specified by:

getClassPK in interface AttachedModel

Returns:

the class pk of this ratings stats

setClassPK

void setClassPK(long classPK)

Sets the class pk of this ratings stats.

Specified by:

setClassPK in interface AttachedModel

Parameters:

classPK - the class pk of this ratings stats

getTotalEntries

int getTotalEntries()

Returns 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()

Returns 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()

Returns 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

isNew

boolean isNew()

Description copied from interface: BaseModel

Returns true 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

Returns true 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

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<RatingsStats>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<RatingsStats>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<RatingsStats>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<RatingsStats>

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<RatingsStats>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<RatingsStats>

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 be applied

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

toCacheModel

CacheModel<RatingsStats> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<RatingsStats>

Returns:

the cache model object

toEscapedModel

RatingsStats toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<RatingsStats>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

RatingsStats toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<RatingsStats>

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<RatingsStats>

Returns:

the XML representation of this model instance