Liferay 6.1.2-ce-ga3

com.liferay.portlet.social.model
Interface SocialActivityCounterModel

All Superinterfaces:
AttachedModel, BaseModel<SocialActivityCounter>, ClassedModel, Cloneable, Comparable<SocialActivityCounter>, Serializable
All Known Subinterfaces:
SocialActivityCounter
All Known Implementing Classes:
SocialActivityCounterWrapper

public interface SocialActivityCounterModel
extends AttachedModel, BaseModel<SocialActivityCounter>

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

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

See Also:
SocialActivityCounter, SocialActivityCounterImpl, SocialActivityCounterModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(SocialActivityCounter socialActivityCounter)
           
 long getActivityCounterId()
          Returns the activity counter ID of this social activity counter.
 String getClassName()
          Returns the fully qualified class name of this social activity counter.
 long getClassNameId()
          Returns the class name ID of this social activity counter.
 long getClassPK()
          Returns the class p k of this social activity counter.
 long getCompanyId()
          Returns the company ID of this social activity counter.
 int getCurrentValue()
          Returns the current value of this social activity counter.
 int getEndPeriod()
          Returns the end period of this social activity counter.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 int getGraceValue()
          Returns the grace value of this social activity counter.
 long getGroupId()
          Returns the group ID of this social activity counter.
 String getName()
          Returns the name of this social activity counter.
 int getOwnerType()
          Returns the owner type of this social activity counter.
 long getPrimaryKey()
          Returns the primary key of this social activity counter.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 int getStartPeriod()
          Returns the start period of this social activity counter.
 int getTotalValue()
          Returns the total value of this social activity counter.
 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 setActivityCounterId(long activityCounterId)
          Sets the activity counter ID of this social activity counter.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassName(String className)
           
 void setClassNameId(long classNameId)
          Sets the class name ID of this social activity counter.
 void setClassPK(long classPK)
          Sets the class p k of this social activity counter.
 void setCompanyId(long companyId)
          Sets the company ID of this social activity counter.
 void setCurrentValue(int currentValue)
          Sets the current value of this social activity counter.
 void setEndPeriod(int endPeriod)
          Sets the end period of this social activity counter.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setGraceValue(int graceValue)
          Sets the grace value of this social activity counter.
 void setGroupId(long groupId)
          Sets the group ID of this social activity counter.
 void setName(String name)
          Sets the name of this social activity counter.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setOwnerType(int ownerType)
          Sets the owner type of this social activity counter.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this social activity counter.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setStartPeriod(int startPeriod)
          Sets the start period of this social activity counter.
 void setTotalValue(int totalValue)
          Sets the total value of this social activity counter.
 CacheModel<SocialActivityCounter> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 SocialActivityCounter toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 SocialActivityCounter toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this social activity counter.

Returns:
the primary key of this social activity counter

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this social activity counter.

Parameters:
primaryKey - the primary key of this social activity counter

getActivityCounterId

long getActivityCounterId()
Returns the activity counter ID of this social activity counter.

Returns:
the activity counter ID of this social activity counter

setActivityCounterId

void setActivityCounterId(long activityCounterId)
Sets the activity counter ID of this social activity counter.

Parameters:
activityCounterId - the activity counter ID of this social activity counter

getGroupId

long getGroupId()
Returns the group ID of this social activity counter.

Returns:
the group ID of this social activity counter

setGroupId

void setGroupId(long groupId)
Sets the group ID of this social activity counter.

Parameters:
groupId - the group ID of this social activity counter

getCompanyId

long getCompanyId()
Returns the company ID of this social activity counter.

Returns:
the company ID of this social activity counter

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this social activity counter.

Parameters:
companyId - the company ID of this social activity counter

getClassName

String getClassName()
Returns the fully qualified class name of this social activity counter.

Specified by:
getClassName in interface AttachedModel
Returns:
the fully qualified class name of this social activity counter

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()
Returns the class name ID of this social activity counter.

Specified by:
getClassNameId in interface AttachedModel
Returns:
the class name ID of this social activity counter

setClassNameId

void setClassNameId(long classNameId)
Sets the class name ID of this social activity counter.

Specified by:
setClassNameId in interface AttachedModel
Parameters:
classNameId - the class name ID of this social activity counter

getClassPK

long getClassPK()
Returns the class p k of this social activity counter.

Specified by:
getClassPK in interface AttachedModel
Returns:
the class p k of this social activity counter

setClassPK

void setClassPK(long classPK)
Sets the class p k of this social activity counter.

Specified by:
setClassPK in interface AttachedModel
Parameters:
classPK - the class p k of this social activity counter

getName

@AutoEscape
String getName()
Returns the name of this social activity counter.

Returns:
the name of this social activity counter

setName

void setName(String name)
Sets the name of this social activity counter.

Parameters:
name - the name of this social activity counter

getOwnerType

int getOwnerType()
Returns the owner type of this social activity counter.

Returns:
the owner type of this social activity counter

setOwnerType

void setOwnerType(int ownerType)
Sets the owner type of this social activity counter.

Parameters:
ownerType - the owner type of this social activity counter

getCurrentValue

int getCurrentValue()
Returns the current value of this social activity counter.

Returns:
the current value of this social activity counter

setCurrentValue

void setCurrentValue(int currentValue)
Sets the current value of this social activity counter.

Parameters:
currentValue - the current value of this social activity counter

getTotalValue

int getTotalValue()
Returns the total value of this social activity counter.

Returns:
the total value of this social activity counter

setTotalValue

void setTotalValue(int totalValue)
Sets the total value of this social activity counter.

Parameters:
totalValue - the total value of this social activity counter

getGraceValue

int getGraceValue()
Returns the grace value of this social activity counter.

Returns:
the grace value of this social activity counter

setGraceValue

void setGraceValue(int graceValue)
Sets the grace value of this social activity counter.

Parameters:
graceValue - the grace value of this social activity counter

getStartPeriod

int getStartPeriod()
Returns the start period of this social activity counter.

Returns:
the start period of this social activity counter

setStartPeriod

void setStartPeriod(int startPeriod)
Sets the start period of this social activity counter.

Parameters:
startPeriod - the start period of this social activity counter

getEndPeriod

int getEndPeriod()
Returns the end period of this social activity counter.

Returns:
the end period of this social activity counter

setEndPeriod

void setEndPeriod(int endPeriod)
Sets the end period of this social activity counter.

Parameters:
endPeriod - the end period of this social activity counter

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<SocialActivityCounter>
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<SocialActivityCounter>
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<SocialActivityCounter>
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<SocialActivityCounter>
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<SocialActivityCounter>
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<SocialActivityCounter>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<SocialActivityCounter>
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<SocialActivityCounter>
Specified by:
getExpandoBridge in interface ClassedModel
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<SocialActivityCounter>
Parameters:
serviceContext - the service context
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<SocialActivityCounter>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(SocialActivityCounter socialActivityCounter)
Specified by:
compareTo in interface Comparable<SocialActivityCounter>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<SocialActivityCounter> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<SocialActivityCounter>
Returns:
the cache model object

toEscapedModel

SocialActivityCounter 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<SocialActivityCounter>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

SocialActivityCounter toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<SocialActivityCounter>

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<SocialActivityCounter>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3