com.liferay.social.kernel.model

Interface SocialRelationModel

All Superinterfaces:

BaseModel<SocialRelation>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<SocialRelation>, java.io.Serializable, ShardedModel

All Known Subinterfaces:

SocialRelation

All Known Implementing Classes:

SocialRelationWrapper

@ProviderType
public interface SocialRelationModel
extends BaseModel<SocialRelation>, ShardedModel

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

This interface and its corresponding implementation com.liferay.portlet.social.model.impl.SocialRelationModelImpl 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.SocialRelationImpl.

Author:

Brian Wing Shun Chan

See Also:

SocialRelation

Generated:

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(SocialRelation socialRelation)
long	getCompanyId() Returns the company ID of this social relation.
long	getCreateDate() Returns the create date of this social relation.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getPrimaryKey() Returns the primary key of this social relation.
java.io.Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
long	getRelationId() Returns the relation ID of this social relation.
int	getType() Returns the type of this social relation.
long	getUserId1() Returns the user id1 of this social relation.
long	getUserId2() Returns the user id2 of this social relation.
java.lang.String	getUuid() Returns the uuid of this social relation.
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	setCompanyId(long companyId) Sets the company ID of this social relation.
void	setCreateDate(long createDate) Sets the create date of this social relation.
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 social relation.
void	setPrimaryKeyObj(java.io.Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setRelationId(long relationId) Sets the relation ID of this social relation.
void	setType(int type) Sets the type of this social relation.
void	setUserId1(long userId1) Sets the user id1 of this social relation.
void	setUserId2(long userId2) Sets the user id2 of this social relation.
void	setUuid(java.lang.String uuid) Sets the uuid of this social relation.
CacheModel<SocialRelation>	toCacheModel() Returns a cache model object for this entity used by entity cache.
SocialRelation	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
java.lang.String	toString()
SocialRelation	toUnescapedModel()
java.lang.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 social relation.

Returns:

the primary key of this social relation

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this social relation.

Parameters:

primaryKey - the primary key of this social relation

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this social relation.

Returns:

the uuid of this social relation

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this social relation.

Parameters:

uuid - the uuid of this social relation

getRelationId

long getRelationId()

Returns the relation ID of this social relation.

Returns:

the relation ID of this social relation

setRelationId

void setRelationId(long relationId)

Sets the relation ID of this social relation.

Parameters:

relationId - the relation ID of this social relation

getCompanyId

long getCompanyId()

Returns the company ID of this social relation.

Specified by:

getCompanyId in interface ShardedModel

Returns:

the company ID of this social relation

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this social relation.

Specified by:

setCompanyId in interface ShardedModel

Parameters:

companyId - the company ID of this social relation

getCreateDate

long getCreateDate()

Returns the create date of this social relation.

Returns:

the create date of this social relation

setCreateDate

void setCreateDate(long createDate)

Sets the create date of this social relation.

Parameters:

createDate - the create date of this social relation

getUserId1

long getUserId1()

Returns the user id1 of this social relation.

Returns:

the user id1 of this social relation

setUserId1

void setUserId1(long userId1)

Sets the user id1 of this social relation.

Parameters:

userId1 - the user id1 of this social relation

getUserId2

long getUserId2()

Returns the user id2 of this social relation.

Returns:

the user id2 of this social relation

setUserId2

void setUserId2(long userId2)

Sets the user id2 of this social relation.

Parameters:

userId2 - the user id2 of this social relation

getType

int getType()

Returns the type of this social relation.

Returns:

the type of this social relation

setType

void setType(int type)

Sets the type of this social relation.

Parameters:

type - the type of this social relation

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

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

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

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

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

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

java.io.Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<SocialRelation>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<SocialRelation>

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

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

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<SocialRelation>

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

Parameters:

serviceContext - the service context to be applied

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(SocialRelation socialRelation)

Specified by:

compareTo in interface java.lang.Comparable<SocialRelation>

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

toCacheModel

CacheModel<SocialRelation> toCacheModel()

Description copied from interface: BaseModel

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

Specified by:

toCacheModel in interface BaseModel<SocialRelation>

Returns:

the cache model object

toEscapedModel

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

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

SocialRelation toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<SocialRelation>

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXmlString

java.lang.String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<SocialRelation>

Returns:

the XML representation of this model instance