com.liferay.portal.model
Class SubscriptionWrapper

java.lang.Object
  com.liferay.portal.model.SubscriptionWrapper

All Implemented Interfaces:

AttachedModel, AuditedModel, BaseModel<Subscription>, ClassedModel, ModelWrapper<Subscription>, PersistedModel, Subscription, SubscriptionModel, Serializable, Cloneable, Comparable<Subscription>

public class SubscriptionWrapper
extends Object
implements Subscription, ModelWrapper<Subscription>

This class is a wrapper for Subscription.

See Also:

Subscription, Serialized Form

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

Constructor Summary

SubscriptionWrapper(Subscription subscription)

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(Subscription subscription)
boolean	equals(Object obj)
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 p k 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.
Map<String,Object>	getModelAttributes()
Class<?>	getModelClass()
String	getModelClassName()
Date	getModifiedDate() Returns the modified date 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.
Subscription	getWrappedModel()
Subscription	getWrappedSubscription() Deprecated. Renamed to getWrappedModel()
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	persist() Updates this model instance in the database or adds it if it does not yet exist.
void	resetOriginalValues() Reset all original fields to current values.
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 p k 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(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	setModelAttributes(Map<String,Object> attributes)
void	setModifiedDate(Date modifiedDate) Sets the modified date 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 class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SubscriptionWrapper

public SubscriptionWrapper(Subscription subscription)

Method Detail

getModelClass

public Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()

Specified by:

getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()

Specified by:

getModelAttributes in interface BaseModel<Subscription>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)

Specified by:

setModelAttributes in interface BaseModel<Subscription>

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this subscription.

Specified by:

getPrimaryKey in interface SubscriptionModel

Returns:

the primary key of this subscription

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Sets the primary key of this subscription.

Specified by:

setPrimaryKey in interface SubscriptionModel

Parameters:

primaryKey - the primary key of this subscription

getSubscriptionId

public long getSubscriptionId()

Returns the subscription ID of this subscription.

Specified by:

getSubscriptionId in interface SubscriptionModel

Returns:

the subscription ID of this subscription

setSubscriptionId

public void setSubscriptionId(long subscriptionId)

Sets the subscription ID of this subscription.

Specified by:

setSubscriptionId in interface SubscriptionModel

Parameters:

subscriptionId - the subscription ID of this subscription

getCompanyId

public long getCompanyId()

Returns the company ID of this subscription.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface SubscriptionModel

Returns:

the company ID of this subscription

setCompanyId

public void setCompanyId(long companyId)

Sets the company ID of this subscription.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface SubscriptionModel

Parameters:

companyId - the company ID of this subscription

getUserId

public long getUserId()

Returns the user ID of this subscription.

Specified by:

getUserId in interface AuditedModel

Specified by:

getUserId in interface SubscriptionModel

Returns:

the user ID of this subscription

setUserId

public void setUserId(long userId)

Sets the user ID of this subscription.

Specified by:

setUserId in interface AuditedModel

Specified by:

setUserId in interface SubscriptionModel

Parameters:

userId - the user ID of this subscription

getUserUuid

public String getUserUuid()
                   throws SystemException

Returns the user uuid of this subscription.

Specified by:

getUserUuid in interface AuditedModel

Specified by:

getUserUuid in interface SubscriptionModel

Returns:

the user uuid of this subscription

Throws:

SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(String userUuid)

Sets the user uuid of this subscription.

Specified by:

setUserUuid in interface AuditedModel

Specified by:

setUserUuid in interface SubscriptionModel

Parameters:

userUuid - the user uuid of this subscription

getUserName

public String getUserName()

Returns the user name of this subscription.

Specified by:

getUserName in interface AuditedModel

Specified by:

getUserName in interface SubscriptionModel

Returns:

the user name of this subscription

setUserName

public void setUserName(String userName)

Sets the user name of this subscription.

Specified by:

setUserName in interface AuditedModel

Specified by:

setUserName in interface SubscriptionModel

Parameters:

userName - the user name of this subscription

getCreateDate

public Date getCreateDate()

Returns the create date of this subscription.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface SubscriptionModel

Returns:

the create date of this subscription

setCreateDate

public void setCreateDate(Date createDate)

Sets the create date of this subscription.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface SubscriptionModel

Parameters:

createDate - the create date of this subscription

getModifiedDate

public Date getModifiedDate()

Returns the modified date of this subscription.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface SubscriptionModel

Returns:

the modified date of this subscription

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Sets the modified date of this subscription.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface SubscriptionModel

Parameters:

modifiedDate - the modified date of this subscription

getClassName

public String getClassName()

Returns the fully qualified class name of this subscription.

Specified by:

getClassName in interface AttachedModel

Specified by:

getClassName in interface SubscriptionModel

Returns:

the fully qualified class name of this subscription

setClassName

public void setClassName(String className)

Specified by:

setClassName in interface SubscriptionModel

getClassNameId

public long getClassNameId()

Returns the class name ID of this subscription.

Specified by:

getClassNameId in interface AttachedModel

Specified by:

getClassNameId in interface SubscriptionModel

Returns:

the class name ID of this subscription

setClassNameId

public void setClassNameId(long classNameId)

Sets the class name ID of this subscription.

Specified by:

setClassNameId in interface AttachedModel

Specified by:

setClassNameId in interface SubscriptionModel

Parameters:

classNameId - the class name ID of this subscription

getClassPK

public long getClassPK()

Returns the class p k of this subscription.

Specified by:

getClassPK in interface AttachedModel

Specified by:

getClassPK in interface SubscriptionModel

Returns:

the class p k of this subscription

setClassPK

public void setClassPK(long classPK)

Sets the class p k of this subscription.

Specified by:

setClassPK in interface AttachedModel

Specified by:

setClassPK in interface SubscriptionModel

Parameters:

classPK - the class p k of this subscription

getFrequency

public String getFrequency()

Returns the frequency of this subscription.

Specified by:

getFrequency in interface SubscriptionModel

Returns:

the frequency of this subscription

setFrequency

public void setFrequency(String frequency)

Sets the frequency of this subscription.

Specified by:

setFrequency in interface SubscriptionModel

Parameters:

frequency - the frequency of this subscription

isNew

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

Specified by:

isNew in interface SubscriptionModel

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

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

Specified by:

setNew in interface SubscriptionModel

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

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

Specified by:

isCachedModel in interface SubscriptionModel

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

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

Specified by:

setCachedModel in interface SubscriptionModel

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<Subscription>

Specified by:

isEscapedModel in interface SubscriptionModel

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

public 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

Specified by:

getPrimaryKeyObj in interface SubscriptionModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

public 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

Specified by:

setPrimaryKeyObj in interface SubscriptionModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

public 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

Specified by:

getExpandoBridge in interface SubscriptionModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

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

Specified by:

setExpandoBridgeAttributes in interface SubscriptionModel

Parameters:

serviceContext - the service context

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

public Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<Subscription>

Specified by:

clone in interface SubscriptionModel

Overrides:

clone in class Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(Subscription subscription)

Specified by:

compareTo in interface SubscriptionModel

Specified by:

compareTo in interface Comparable<Subscription>

hashCode

public int hashCode()

Specified by:

hashCode in interface SubscriptionModel

Overrides:

hashCode in class Object

toCacheModel

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

Specified by:

toCacheModel in interface SubscriptionModel

Returns:

the cache model object

toEscapedModel

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

Specified by:

toEscapedModel in interface SubscriptionModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

public Subscription toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<Subscription>

Specified by:

toUnescapedModel in interface SubscriptionModel

toString

public String toString()

Specified by:

toString in interface SubscriptionModel

Overrides:

toString in class Object

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<Subscription>

Specified by:

toXmlString in interface SubscriptionModel

Returns:

the XML representation of this model instance

persist

public void persist()
             throws SystemException

Description copied from interface: PersistedModel

Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:

persist in interface PersistedModel

Throws:

SystemException - if a system exception occurred

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getWrappedSubscription

public Subscription getWrappedSubscription()

Deprecated. Renamed to getWrappedModel()

getWrappedModel

public Subscription getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<Subscription>

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<Subscription>