com.liferay.portlet.social.model
Interface SocialEquitySettingModel

All Superinterfaces:

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

All Known Subinterfaces:

SocialEquitySetting

All Known Implementing Classes:

SocialEquitySettingWrapper

public interface SocialEquitySettingModel
extends BaseModel<SocialEquitySetting>

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

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

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

Author:

Brian Wing Shun Chan

See Also:

SocialEquitySetting, com.liferay.portlet.social.model.impl.SocialEquitySettingImpl, com.liferay.portlet.social.model.impl.SocialEquitySettingModelImpl

Generated:

Method Summary

java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(SocialEquitySetting socialEquitySetting)
java.lang.String	getActionId() Gets the action id of this social equity setting.
java.lang.String	getClassName() Gets the class name of the model instance this social equity setting is polymorphically associated with.
long	getClassNameId() Gets the class name id of this social equity setting.
long	getCompanyId() Gets the company id of this social equity setting.
int	getDailyLimit() Gets the daily limit of this social equity setting.
long	getEquitySettingId() Gets the equity setting id of this social equity setting.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this social equity setting.
int	getLifespan() Gets the lifespan of this social equity setting.
long	getPrimaryKey() Gets the primary key of this social equity setting.
java.io.Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
int	getType() Gets the type of this social equity setting.
boolean	getUniqueEntry() Gets the unique entry of this social equity setting.
int	getValue() Gets the value of this social equity setting.
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.
boolean	isUniqueEntry() Determines if this social equity setting is unique entry.
void	setActionId(java.lang.String actionId) Sets the action id of this social equity setting.
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 equity setting.
void	setCompanyId(long companyId) Sets the company id of this social equity setting.
void	setDailyLimit(int dailyLimit) Sets the daily limit of this social equity setting.
void	setEquitySettingId(long equitySettingId) Sets the equity setting id of this social equity setting.
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 setting.
void	setLifespan(int lifespan) Sets the lifespan of this social equity setting.
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 equity setting
void	setType(int type) Sets the type of this social equity setting.
void	setUniqueEntry(boolean uniqueEntry) Sets whether this {$entity.humanName} is unique entry.
void	setValue(int value) Sets the value of this social equity setting.
SocialEquitySetting	toEscapedModel() Gets a copy of this social equity setting 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 equity setting.

Returns:

the primary key of this social equity setting

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this social equity setting

Parameters:

pk - the primary key of this social equity setting

getEquitySettingId

long getEquitySettingId()

Gets the equity setting id of this social equity setting.

Returns:

the equity setting id of this social equity setting

setEquitySettingId

void setEquitySettingId(long equitySettingId)

Sets the equity setting id of this social equity setting.

Parameters:

equitySettingId - the equity setting id of this social equity setting

getGroupId

long getGroupId()

Gets the group id of this social equity setting.

Returns:

the group id of this social equity setting

setGroupId

void setGroupId(long groupId)

Sets the group id of this social equity setting.

Parameters:

groupId - the group id of this social equity setting

getCompanyId

long getCompanyId()

Gets the company id of this social equity setting.

Returns:

the company id of this social equity setting

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this social equity setting.

Parameters:

companyId - the company id of this social equity setting

getClassName

java.lang.String getClassName()

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

Returns:

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

getClassNameId

long getClassNameId()

Gets the class name id of this social equity setting.

Returns:

the class name id of this social equity setting

setClassNameId

void setClassNameId(long classNameId)

Sets the class name id of this social equity setting.

Parameters:

classNameId - the class name id of this social equity setting

getActionId

@AutoEscape
java.lang.String getActionId()

Gets the action id of this social equity setting.

Returns:

the action id of this social equity setting

setActionId

void setActionId(java.lang.String actionId)

Sets the action id of this social equity setting.

Parameters:

actionId - the action id of this social equity setting

getDailyLimit

int getDailyLimit()

Gets the daily limit of this social equity setting.

Returns:

the daily limit of this social equity setting

setDailyLimit

void setDailyLimit(int dailyLimit)

Sets the daily limit of this social equity setting.

Parameters:

dailyLimit - the daily limit of this social equity setting

getLifespan

int getLifespan()

Gets the lifespan of this social equity setting.

Returns:

the lifespan of this social equity setting

setLifespan

void setLifespan(int lifespan)

Sets the lifespan of this social equity setting.

Parameters:

lifespan - the lifespan of this social equity setting

getType

int getType()

Gets the type of this social equity setting.

Returns:

the type of this social equity setting

setType

void setType(int type)

Sets the type of this social equity setting.

Parameters:

type - the type of this social equity setting

getUniqueEntry

boolean getUniqueEntry()

Gets the unique entry of this social equity setting.

Returns:

the unique entry of this social equity setting

isUniqueEntry

boolean isUniqueEntry()

Determines if this social equity setting is unique entry.

Returns:

true if this social equity setting is unique entry; false otherwise

setUniqueEntry

void setUniqueEntry(boolean uniqueEntry)

Sets whether this {$entity.humanName} is unique entry.

Parameters:

uniqueEntry - the unique entry of this social equity setting

getValue

int getValue()

Gets the value of this social equity setting.

Returns:

the value of this social equity setting

setValue

void setValue(int value)

Sets the value of this social equity setting.

Parameters:

value - the value of this social equity setting

toEscapedModel

SocialEquitySetting toEscapedModel()

Gets a copy of this social equity setting 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<SocialEquitySetting>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(SocialEquitySetting socialEquitySetting)

Specified by:

compareTo in interface java.lang.Comparable<SocialEquitySetting>

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

Returns:

the XML representation of this model instance