com.liferay.portlet.social.model
Interface SocialActivityModel

All Superinterfaces:

BaseModel<SocialActivity>, java.lang.Cloneable, java.lang.Comparable<SocialActivity>, java.io.Serializable

All Known Subinterfaces:

SocialActivity

All Known Implementing Classes:

SocialActivityWrapper

public interface SocialActivityModel
extends 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 com.liferay.portlet.social.model.impl.SocialActivityModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portlet.social.model.impl.SocialActivityImpl.

Never modify or reference this interface directly. All methods that expect a social activity model instance should use the SocialActivity interface instead.

Author:

Brian Wing Shun Chan

See Also:

SocialActivity, com.liferay.portlet.social.model.impl.SocialActivityImpl, com.liferay.portlet.social.model.impl.SocialActivityModelImpl

Generated:

Method Summary

java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(SocialActivity socialActivity)
long	getActivityId() Gets the activity id of this social activity.
java.lang.String	getClassName() Gets the class name of the model instance this social activity is polymorphically associated with.
long	getClassNameId() Gets the class name id of this social activity.
long	getClassPK() Gets the class p k of this social activity.
long	getCompanyId() Gets the company id of this social activity.
long	getCreateDate() Gets the create date of this social activity.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
java.lang.String	getExtraData() Gets the extra data of this social activity.
long	getGroupId() Gets the group id of this social activity.
long	getMirrorActivityId() Gets the mirror activity id of this social activity.
long	getPrimaryKey() Gets the primary key of this social activity.
java.io.Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getReceiverUserId() Gets the receiver user id of this social activity.
java.lang.String	getReceiverUserUuid() Gets the receiver user uuid of this social activity.
int	getType() Gets the type of this social activity.
long	getUserId() Gets the user id of this social activity.
java.lang.String	getUserUuid() Gets the user uuid of this social activity.
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	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	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	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	setExtraData(java.lang.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 pk) Sets the primary key of this social activity
void	setReceiverUserId(long receiverUserId) Sets the receiver user id of this social activity.
void	setReceiverUserUuid(java.lang.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(java.lang.String userUuid) Sets the user uuid of this social activity.
SocialActivity	toEscapedModel() Gets a copy of this social activity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
java.lang.String	toString()
java.lang.String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this social activity.

Returns:

the primary key of this social activity

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this social activity

Parameters:

pk - the primary key of this social activity

getActivityId

long getActivityId()

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

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

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

Gets 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

java.lang.String getUserUuid()
                             throws SystemException

Gets 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(java.lang.String userUuid)

Sets the user uuid of this social activity.

Parameters:

userUuid - the user uuid of this social activity

getCreateDate

long getCreateDate()

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

Gets 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

java.lang.String getClassName()

Gets the class name of the model instance this social activity is polymorphically associated with.

Returns:

the class name of the model instance this social activity is polymorphically associated with

getClassNameId

long getClassNameId()

Gets the class name id of this social activity.

Returns:

the class name id of this social activity

setClassNameId

void setClassNameId(long classNameId)

Sets the class name id of this social activity.

Parameters:

classNameId - the class name id of this social activity

getClassPK

long getClassPK()

Gets the class p k of this social activity.

Returns:

the class p k of this social activity

setClassPK

void setClassPK(long classPK)

Sets the class p k of this social activity.

Parameters:

classPK - the class p k of this social activity

getType

int getType()

Gets 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
java.lang.String getExtraData()

Gets the extra data of this social activity.

Returns:

the extra data of this social activity

setExtraData

void setExtraData(java.lang.String extraData)

Sets the extra data of this social activity.

Parameters:

extraData - the extra data of this social activity

getReceiverUserId

long getReceiverUserId()

Gets 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

java.lang.String getReceiverUserUuid()
                                     throws SystemException

Gets 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(java.lang.String receiverUserUuid)

Sets the receiver user uuid of this social activity.

Parameters:

receiverUserUuid - the receiver user uuid of this social activity

toEscapedModel

SocialActivity toEscapedModel()

Gets a copy of this social activity 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<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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<SocialActivity>

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

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

java.io.Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<SocialActivity>

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

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 to retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

java.lang.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 java.lang.Comparable<SocialActivity>

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXmlString

java.lang.String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<SocialActivity>

Returns:

the XML representation of this model instance