Liferay 6.1.2-ce-ga3

com.liferay.portlet.ratings.model
Interface RatingsEntryModel

All Superinterfaces:
AttachedModel, AuditedModel, BaseModel<RatingsEntry>, ClassedModel, Cloneable, Comparable<RatingsEntry>, Serializable
All Known Subinterfaces:
RatingsEntry
All Known Implementing Classes:
RatingsEntryBaseImpl, RatingsEntryImpl, RatingsEntryModelImpl, RatingsEntryWrapper

public interface RatingsEntryModel
extends AttachedModel, AuditedModel, 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.

See Also:
RatingsEntry, RatingsEntryImpl, RatingsEntryModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(RatingsEntry ratingsEntry)
           
 String getClassName()
          Returns the fully qualified class name of this ratings entry.
 long getClassNameId()
          Returns the class name ID of this ratings entry.
 long getClassPK()
          Returns the class p k of this ratings entry.
 long getCompanyId()
          Returns the company ID of this ratings entry.
 Date getCreateDate()
          Returns the create date of this ratings entry.
 long getEntryId()
          Returns the entry ID of this ratings entry.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 Date getModifiedDate()
          Returns the modified date of this ratings entry.
 long getPrimaryKey()
          Returns the primary key of this ratings entry.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 double getScore()
          Returns the score of this ratings entry.
 long getUserId()
          Returns the user ID of this ratings entry.
 String getUserName()
          Returns the user name of this ratings entry.
 String getUserUuid()
          Returns the user uuid of this ratings entry.
 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 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 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 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 primaryKey)
          Sets the primary key of this ratings entry.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 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.
 CacheModel<RatingsEntry> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 RatingsEntry toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 RatingsEntry toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this ratings entry.

Returns:
the primary key of this ratings entry

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this ratings entry.

Parameters:
primaryKey - the primary key of this ratings entry

getEntryId

long getEntryId()
Returns 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()
Returns the company ID of this ratings entry.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this ratings entry

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this ratings entry.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this ratings entry

getUserId

long getUserId()
Returns the user ID of this ratings entry.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this ratings entry

setUserId

void setUserId(long userId)
Sets the user ID of this ratings entry.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this ratings entry

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this ratings entry.

Specified by:
getUserUuid in interface AuditedModel
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.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this ratings entry

getUserName

@AutoEscape
String getUserName()
Returns the user name of this ratings entry.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this ratings entry

setUserName

void setUserName(String userName)
Sets the user name of this ratings entry.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this ratings entry

getCreateDate

Date getCreateDate()
Returns the create date of this ratings entry.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this ratings entry

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this ratings entry.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this ratings entry

getModifiedDate

Date getModifiedDate()
Returns the modified date of this ratings entry.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this ratings entry

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this ratings entry.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this ratings entry

getClassName

String getClassName()
Returns the fully qualified class name of this ratings entry.

Specified by:
getClassName in interface AttachedModel
Returns:
the fully qualified class name of this ratings entry

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()
Returns the class name ID of this ratings entry.

Specified by:
getClassNameId in interface AttachedModel
Returns:
the class name ID of this ratings entry

setClassNameId

void setClassNameId(long classNameId)
Sets the class name ID of this ratings entry.

Specified by:
setClassNameId in interface AttachedModel
Parameters:
classNameId - the class name ID of this ratings entry

getClassPK

long getClassPK()
Returns the class p k of this ratings entry.

Specified by:
getClassPK in interface AttachedModel
Returns:
the class p k of this ratings entry

setClassPK

void setClassPK(long classPK)
Sets the class p k of this ratings entry.

Specified by:
setClassPK in interface AttachedModel
Parameters:
classPK - the class p k of this ratings entry

getScore

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

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<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
Returns true 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
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<RatingsEntry>
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<RatingsEntry>
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<RatingsEntry>
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<RatingsEntry>
Specified by:
getExpandoBridge in interface ClassedModel
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
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

toCacheModel

CacheModel<RatingsEntry> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<RatingsEntry>
Returns:
the cache model object

toEscapedModel

RatingsEntry 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<RatingsEntry>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

RatingsEntry toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<RatingsEntry>

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<RatingsEntry>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3