com.liferay.portlet.social.model
Interface SocialEquityUserModel

All Superinterfaces:

BaseModel<SocialEquityUser>, Cloneable, Comparable<SocialEquityUser>, Serializable

All Known Subinterfaces:

SocialEquityUser

All Known Implementing Classes:

SocialEquityUserImpl, SocialEquityUserModelImpl, SocialEquityUserWrapper

public interface SocialEquityUserModel
extends BaseModel<SocialEquityUser>

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

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

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

See Also:

SocialEquityUser, SocialEquityUserImpl, SocialEquityUserModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(SocialEquityUser socialEquityUser)
long	getCompanyId() Gets the company id of this social equity user.
double	getContributionB() Gets the contribution b of this social equity user.
double	getContributionK() Gets the contribution k of this social equity user.
long	getEquityUserId() Gets the equity user id of this social equity user.
String	getEquityUserUuid() Gets the equity user uuid of this social equity user.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this social equity user.
double	getParticipationB() Gets the participation b of this social equity user.
double	getParticipationK() Gets the participation k of this social equity user.
long	getPrimaryKey() Gets the primary key of this social equity user.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
int	getRank() Gets the rank of this social equity user.
long	getUserId() Gets the user id of this social equity user.
String	getUserUuid() Gets the user uuid of this social equity user.
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 equity user.
void	setContributionB(double contributionB) Sets the contribution b of this social equity user.
void	setContributionK(double contributionK) Sets the contribution k of this social equity user.
void	setEquityUserId(long equityUserId) Sets the equity user id of this social equity user.
void	setEquityUserUuid(String equityUserUuid) Sets the equity user uuid of this social equity user.
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	setGroupId(long groupId) Sets the group id of this social equity user.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setParticipationB(double participationB) Sets the participation b of this social equity user.
void	setParticipationK(double participationK) Sets the participation k of this social equity user.
void	setPrimaryKey(long pk) Sets the primary key of this social equity user
void	setRank(int rank) Sets the rank of this social equity user.
void	setUserId(long userId) Sets the user id of this social equity user.
void	setUserUuid(String userUuid) Sets the user uuid of this social equity user.
SocialEquityUser	toEscapedModel() Gets a copy of this social equity user as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this social equity user.

Returns:

the primary key of this social equity user

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this social equity user

Parameters:

pk - the primary key of this social equity user

getEquityUserId

long getEquityUserId()

Gets the equity user id of this social equity user.

Returns:

the equity user id of this social equity user

setEquityUserId

void setEquityUserId(long equityUserId)

Sets the equity user id of this social equity user.

Parameters:

equityUserId - the equity user id of this social equity user

getEquityUserUuid

String getEquityUserUuid()
                         throws SystemException

Gets the equity user uuid of this social equity user.

Returns:

the equity user uuid of this social equity user

Throws:

SystemException - if a system exception occurred

setEquityUserUuid

void setEquityUserUuid(String equityUserUuid)

Sets the equity user uuid of this social equity user.

Parameters:

equityUserUuid - the equity user uuid of this social equity user

getGroupId

long getGroupId()

Gets the group id of this social equity user.

Returns:

the group id of this social equity user

setGroupId

void setGroupId(long groupId)

Sets the group id of this social equity user.

Parameters:

groupId - the group id of this social equity user

getCompanyId

long getCompanyId()

Gets the company id of this social equity user.

Returns:

the company id of this social equity user

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this social equity user.

Parameters:

companyId - the company id of this social equity user

getUserId

long getUserId()

Gets the user id of this social equity user.

Returns:

the user id of this social equity user

setUserId

void setUserId(long userId)

Sets the user id of this social equity user.

Parameters:

userId - the user id of this social equity user

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this social equity user.

Returns:

the user uuid of this social equity user

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this social equity user.

Parameters:

userUuid - the user uuid of this social equity user

getContributionK

double getContributionK()

Gets the contribution k of this social equity user.

Returns:

the contribution k of this social equity user

setContributionK

void setContributionK(double contributionK)

Sets the contribution k of this social equity user.

Parameters:

contributionK - the contribution k of this social equity user

getContributionB

double getContributionB()

Gets the contribution b of this social equity user.

Returns:

the contribution b of this social equity user

setContributionB

void setContributionB(double contributionB)

Sets the contribution b of this social equity user.

Parameters:

contributionB - the contribution b of this social equity user

getParticipationK

double getParticipationK()

Gets the participation k of this social equity user.

Returns:

the participation k of this social equity user

setParticipationK

void setParticipationK(double participationK)

Sets the participation k of this social equity user.

Parameters:

participationK - the participation k of this social equity user

getParticipationB

double getParticipationB()

Gets the participation b of this social equity user.

Returns:

the participation b of this social equity user

setParticipationB

void setParticipationB(double participationB)

Sets the participation b of this social equity user.

Parameters:

participationB - the participation b of this social equity user

getRank

int getRank()

Gets the rank of this social equity user.

Returns:

the rank of this social equity user

setRank

void setRank(int rank)

Sets the rank of this social equity user.

Parameters:

rank - the rank of this social equity user

toEscapedModel

SocialEquityUser toEscapedModel()

Gets a copy of this social equity user 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<SocialEquityUser>

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

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

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

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

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

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<SocialEquityUser>

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

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

Parameters:

serviceContext - the service context to retrieve the expando bridge attributes from

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(SocialEquityUser socialEquityUser)

Specified by:

compareTo in interface Comparable<SocialEquityUser>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<SocialEquityUser>

Returns:

the XML representation of this model instance