com.liferay.portlet.social.model
Interface SocialRelationModel

All Superinterfaces:

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

All Known Subinterfaces:

SocialRelation

All Known Implementing Classes:

SocialRelationWrapper

public interface SocialRelationModel
extends BaseModel<SocialRelation>

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.

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

Author:

Brian Wing Shun Chan

See Also:

SocialRelation, com.liferay.portlet.social.model.impl.SocialRelationImpl, com.liferay.portlet.social.model.impl.SocialRelationModelImpl

Generated:

Method Summary

java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(SocialRelation socialRelation)
long	getCompanyId() Gets the company id of this social relation.
long	getCreateDate() Gets the create date of this social relation.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getPrimaryKey() Gets the primary key of this social relation.
java.io.Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getRelationId() Gets the relation id of this social relation.
int	getType() Gets the type of this social relation.
long	getUserId1() Gets the user id1 of this social relation.
long	getUserId2() Gets the user id2 of this social relation.
java.lang.String	getUuid() Gets the uuid of this social relation.
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	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	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	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 relation
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.
SocialRelation	toEscapedModel() Gets a copy of this social relation 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 relation.

Returns:

the primary key of this social relation

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this social relation

Parameters:

pk - the primary key of this social relation

getUuid

@AutoEscape
java.lang.String getUuid()

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

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

Gets the company id of this social relation.

Returns:

the company id of this social relation

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this social relation.

Parameters:

companyId - the company id of this social relation

getCreateDate

long getCreateDate()

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

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

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

Gets 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

toEscapedModel

SocialRelation toEscapedModel()

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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<SocialRelation>

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

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

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

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

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

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

Returns:

the XML representation of this model instance