com.liferay.portlet.social.model
Interface SocialActivityModel

All Superinterfaces:

AttachedModel, BaseModel<SocialActivity>, ClassedModel, Cloneable, Comparable<SocialActivity>, Serializable

All Known Subinterfaces:

SocialActivity

All Known Implementing Classes:

SocialActivityWrapper

public interface SocialActivityModel
extends AttachedModel, BaseModel<SocialActivity>

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

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

See Also:

SocialActivity, SocialActivityImpl, SocialActivityModelImpl

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(SocialActivity socialActivity)
long	getActivityId() Returns the activity ID of this social activity.
String	getClassName() Returns the fully qualified class name of this social activity.
long	getClassNameId() Returns the class name ID of this social activity.
long	getClassPK() Returns the class p k of this social activity.
long	getCompanyId() Returns the company ID of this social activity.
long	getCreateDate() Returns the create date of this social activity.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
String	getExtraData() Returns the extra data of this social activity.
long	getGroupId() Returns the group ID of this social activity.
long	getMirrorActivityId() Returns the mirror activity ID of this social activity.
long	getPrimaryKey() Returns the primary key of this social activity.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
long	getReceiverUserId() Returns the receiver user ID of this social activity.
String	getReceiverUserUuid() Returns the receiver user uuid of this social activity.
int	getType() Returns the type of this social activity.
long	getUserId() Returns the user ID of this social activity.
String	getUserUuid() Returns the user uuid of this social activity.
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	setActivityId(long activityId) Sets the activity ID of this social activity.
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 social activity.
void	setClassPK(long classPK) Sets the class p k of this social activity.
void	setCompanyId(long companyId) Sets the company ID of this social activity.
void	setCreateDate(long createDate) Sets the create date of this social activity.
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setExtraData(String extraData) Sets the extra data of this social activity.
void	setGroupId(long groupId) Sets the group ID of this social activity.
void	setMirrorActivityId(long mirrorActivityId) Sets the mirror activity ID of this social activity.
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 social activity.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setReceiverUserId(long receiverUserId) Sets the receiver user ID of this social activity.
void	setReceiverUserUuid(String receiverUserUuid) Sets the receiver user uuid of this social activity.
void	setType(int type) Sets the type of this social activity.
void	setUserId(long userId) Sets the user ID of this social activity.
void	setUserUuid(String userUuid) Sets the user uuid of this social activity.
CacheModel<SocialActivity>	toCacheModel() Returns a cache model object for this entity used by entity cache.
SocialActivity	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
SocialActivity	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 social activity.

Returns:

the primary key of this social activity

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this social activity.

Parameters:

primaryKey - the primary key of this social activity

getActivityId

long getActivityId()

Returns the activity ID of this social activity.

Returns:

the activity ID of this social activity

setActivityId

void setActivityId(long activityId)

Sets the activity ID of this social activity.

Parameters:

activityId - the activity ID of this social activity

getGroupId

long getGroupId()

Returns the group ID of this social activity.

Returns:

the group ID of this social activity

setGroupId

void setGroupId(long groupId)

Sets the group ID of this social activity.

Parameters:

groupId - the group ID of this social activity

getCompanyId

long getCompanyId()

Returns the company ID of this social activity.

Returns:

the company ID of this social activity

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this social activity.

Parameters:

companyId - the company ID of this social activity

getUserId

long getUserId()

Returns the user ID of this social activity.

Returns:

the user ID of this social activity

setUserId

void setUserId(long userId)

Sets the user ID of this social activity.

Parameters:

userId - the user ID of this social activity

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this social activity.

Returns:

the user uuid of this social activity

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this social activity.

Parameters:

userUuid - the user uuid of this social activity

getCreateDate

long getCreateDate()

Returns the create date of this social activity.

Returns:

the create date of this social activity

setCreateDate

void setCreateDate(long createDate)

Sets the create date of this social activity.

Parameters:

createDate - the create date of this social activity

getMirrorActivityId

long getMirrorActivityId()

Returns the mirror activity ID of this social activity.

Returns:

the mirror activity ID of this social activity

setMirrorActivityId

void setMirrorActivityId(long mirrorActivityId)

Sets the mirror activity ID of this social activity.

Parameters:

mirrorActivityId - the mirror activity ID of this social activity

getClassName

String getClassName()

Returns the fully qualified class name of this social activity.

Specified by:

getClassName in interface AttachedModel

Returns:

the fully qualified class name of this social activity

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()

Returns the class name ID of this social activity.

Specified by:

getClassNameId in interface AttachedModel

Returns:

the class name ID of this social activity

setClassNameId

void setClassNameId(long classNameId)

Sets the class name ID of this social activity.

Specified by:

setClassNameId in interface AttachedModel

Parameters:

classNameId - the class name ID of this social activity

getClassPK

long getClassPK()

Returns the class p k of this social activity.

Specified by:

getClassPK in interface AttachedModel

Returns:

the class p k of this social activity

setClassPK

void setClassPK(long classPK)

Sets the class p k of this social activity.

Specified by:

setClassPK in interface AttachedModel

Parameters:

classPK - the class p k of this social activity

getType

int getType()

Returns the type of this social activity.

Returns:

the type of this social activity

setType

void setType(int type)

Sets the type of this social activity.

Parameters:

type - the type of this social activity

getExtraData

@AutoEscape
String getExtraData()

Returns the extra data of this social activity.

Returns:

the extra data of this social activity

setExtraData

void setExtraData(String extraData)

Sets the extra data of this social activity.

Parameters:

extraData - the extra data of this social activity

getReceiverUserId

long getReceiverUserId()

Returns the receiver user ID of this social activity.

Returns:

the receiver user ID of this social activity

setReceiverUserId

void setReceiverUserId(long receiverUserId)

Sets the receiver user ID of this social activity.

Parameters:

receiverUserId - the receiver user ID of this social activity

getReceiverUserUuid

String getReceiverUserUuid()
                           throws SystemException

Returns the receiver user uuid of this social activity.

Returns:

the receiver user uuid of this social activity

Throws:

SystemException - if a system exception occurred

setReceiverUserUuid

void setReceiverUserUuid(String receiverUserUuid)

Sets the receiver user uuid of this social activity.

Parameters:

receiverUserUuid - the receiver user uuid of this social activity

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

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(SocialActivity socialActivity)

Specified by:

compareTo in interface Comparable<SocialActivity>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<SocialActivity> toCacheModel()

Description copied from interface: BaseModel

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

Specified by:

toCacheModel in interface BaseModel<SocialActivity>

Returns:

the cache model object

toEscapedModel

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

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

SocialActivity toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<SocialActivity>

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

Returns:

the XML representation of this model instance