com.liferay.portal.kernel.model

Interface SubscriptionModel

All Superinterfaces:

AttachedModel, AuditedModel, BaseModel<Subscription>, ClassedModel, Cloneable, Comparable<Subscription>, GroupedModel, MVCCModel, Serializable, ShardedModel, TypedModel

All Known Subinterfaces:

Subscription

All Known Implementing Classes:

SubscriptionWrapper

@ProviderType
public interface SubscriptionModel
extends AttachedModel, BaseModel<Subscription>, GroupedModel, MVCCModel, ShardedModel

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

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

Author:

Brian Wing Shun Chan

See Also:

Subscription, SubscriptionImpl, SubscriptionModelImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a shallow clone of this model instance.
int	compareTo(Subscription subscription)
String	getClassName() Returns the fully qualified class name of this subscription.
long	getClassNameId() Returns the class name ID of this subscription.
long	getClassPK() Returns the class pk of this subscription.
long	getCompanyId() Returns the company ID of this subscription.
Date	getCreateDate() Returns the create date of this subscription.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
String	getFrequency() Returns the frequency of this subscription.
long	getGroupId() Returns the group ID of this subscription.
Date	getModifiedDate() Returns the modified date of this subscription.
long	getMvccVersion() Returns the mvcc version of this subscription.
long	getPrimaryKey() Returns the primary key of this subscription.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
long	getSubscriptionId() Returns the subscription ID of this subscription.
long	getUserId() Returns the user ID of this subscription.
String	getUserName() Returns the user name of this subscription.
String	getUserUuid() Returns the user uuid of this subscription.
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	setClassName(String className)
void	setClassNameId(long classNameId) Sets the class name ID of this subscription.
void	setClassPK(long classPK) Sets the class pk of this subscription.
void	setCompanyId(long companyId) Sets the company ID of this subscription.
void	setCreateDate(Date createDate) Sets the create date of this subscription.
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	setFrequency(String frequency) Sets the frequency of this subscription.
void	setGroupId(long groupId) Sets the group ID of this subscription.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this subscription.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this subscription.
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 subscription.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setSubscriptionId(long subscriptionId) Sets the subscription ID of this subscription.
void	setUserId(long userId) Sets the user ID of this subscription.
void	setUserName(String userName) Sets the user name of this subscription.
void	setUserUuid(String userUuid) Sets the user uuid of this subscription.
CacheModel<Subscription>	toCacheModel() Returns a cache model object for this entity used by entity cache.
Subscription	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
Subscription	toUnescapedModel()
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 subscription.

Returns:

the primary key of this subscription

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this subscription.

Parameters:

primaryKey - the primary key of this subscription

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this subscription.

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this subscription

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this subscription.

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this subscription

getSubscriptionId

long getSubscriptionId()

Returns the subscription ID of this subscription.

Returns:

the subscription ID of this subscription

setSubscriptionId

void setSubscriptionId(long subscriptionId)

Sets the subscription ID of this subscription.

Parameters:

subscriptionId - the subscription ID of this subscription

getGroupId

long getGroupId()

Returns the group ID of this subscription.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this subscription

setGroupId

void setGroupId(long groupId)

Sets the group ID of this subscription.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this subscription

getCompanyId

long getCompanyId()

Returns the company ID of this subscription.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface ShardedModel

Returns:

the company ID of this subscription

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this subscription.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface ShardedModel

Parameters:

companyId - the company ID of this subscription

getUserId

long getUserId()

Returns the user ID of this subscription.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this subscription

setUserId

void setUserId(long userId)

Sets the user ID of this subscription.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this subscription

getUserUuid

String getUserUuid()

Returns the user uuid of this subscription.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this subscription

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this subscription.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this subscription

getUserName

@AutoEscape
String getUserName()

Returns the user name of this subscription.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this subscription

setUserName

void setUserName(String userName)

Sets the user name of this subscription.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this subscription

getCreateDate

Date getCreateDate()

Returns the create date of this subscription.

Specified by:

getCreateDate in interface AuditedModel

Returns:

the create date of this subscription

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this subscription.

Specified by:

setCreateDate in interface AuditedModel

Parameters:

createDate - the create date of this subscription

getModifiedDate

Date getModifiedDate()

Returns the modified date of this subscription.

Specified by:

getModifiedDate in interface AuditedModel

Returns:

the modified date of this subscription

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this subscription.

Specified by:

setModifiedDate in interface AuditedModel

Parameters:

modifiedDate - the modified date of this subscription

getClassName

String getClassName()

Returns the fully qualified class name of this subscription.

Specified by:

getClassName in interface TypedModel

Returns:

the fully qualified class name of this subscription

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()

Returns the class name ID of this subscription.

Specified by:

getClassNameId in interface TypedModel

Returns:

the class name ID of this subscription

setClassNameId

void setClassNameId(long classNameId)

Sets the class name ID of this subscription.

Specified by:

setClassNameId in interface TypedModel

Parameters:

classNameId - the class name ID of this subscription

getClassPK

long getClassPK()

Returns the class pk of this subscription.

Specified by:

getClassPK in interface AttachedModel

Returns:

the class pk of this subscription

setClassPK

void setClassPK(long classPK)

Sets the class pk of this subscription.

Specified by:

setClassPK in interface AttachedModel

Parameters:

classPK - the class pk of this subscription

getFrequency

@AutoEscape
String getFrequency()

Returns the frequency of this subscription.

Returns:

the frequency of this subscription

setFrequency

void setFrequency(String frequency)

Sets the frequency of this subscription.

Parameters:

frequency - the frequency of this subscription

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

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

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

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

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

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

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

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

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

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<Subscription>

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

Parameters:

serviceContext - the service context to be applied

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(Subscription subscription)

Specified by:

compareTo in interface Comparable<Subscription>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<Subscription> toCacheModel()

Description copied from interface: BaseModel

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

Specified by:

toCacheModel in interface BaseModel<Subscription>

Returns:

the cache model object

toEscapedModel

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

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

Subscription toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<Subscription>

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

Returns:

the XML representation of this model instance