Liferay 6.0.5

com.liferay.portal.model
Class SubscriptionWrapper

java.lang.Object
  extended by com.liferay.portal.model.SubscriptionWrapper
All Implemented Interfaces:
BaseModel<Subscription>, Subscription, SubscriptionModel, Serializable, Cloneable, Comparable<Subscription>

public class SubscriptionWrapper
extends Object
implements 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 is generated.

Constructor Summary
SubscriptionWrapper(Subscription subscription)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Subscription subscription)
           
 String getClassName()
          Gets the class name of the model instance this subscription is polymorphically associated with.
 long getClassNameId()
          Gets the class name id of this subscription.
 long getClassPK()
          Gets the class p k of this subscription.
 long getCompanyId()
          Gets the company id of this subscription.
 Date getCreateDate()
          Gets the create date of this subscription.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getFrequency()
          Gets the frequency of this subscription.
 Date getModifiedDate()
          Gets the modified date of this subscription.
 long getPrimaryKey()
          Gets the primary key of this subscription.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 long getSubscriptionId()
          Gets the subscription id of this subscription.
 long getUserId()
          Gets the user id of this subscription.
 String getUserName()
          Gets the user name of this subscription.
 String getUserUuid()
          Gets the user uuid of this subscription.
 Subscription getWrappedSubscription()
           
 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 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 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 setFrequency(String frequency)
          Sets the frequency of this subscription.
 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 pk)
          Sets the primary key of this subscription
 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.
 Subscription toEscapedModel()
          Gets a copy of this subscription as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SubscriptionWrapper

public SubscriptionWrapper(Subscription subscription)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Description copied from interface: SubscriptionModel
Gets the primary key of this subscription.

Specified by:
getPrimaryKey in interface SubscriptionModel
Returns:
the primary key of this subscription

setPrimaryKey

public void setPrimaryKey(long pk)
Description copied from interface: SubscriptionModel
Sets the primary key of this subscription

Specified by:
setPrimaryKey in interface SubscriptionModel
Parameters:
pk - the primary key of this subscription

getSubscriptionId

public long getSubscriptionId()
Description copied from interface: SubscriptionModel
Gets 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)
Description copied from interface: SubscriptionModel
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()
Description copied from interface: SubscriptionModel
Gets the company id of this subscription.

Specified by:
getCompanyId in interface SubscriptionModel
Returns:
the company id of this subscription

setCompanyId

public void setCompanyId(long companyId)
Description copied from interface: SubscriptionModel
Sets the company id of this subscription.

Specified by:
setCompanyId in interface SubscriptionModel
Parameters:
companyId - the company id of this subscription

getUserId

public long getUserId()
Description copied from interface: SubscriptionModel
Gets the user id of this subscription.

Specified by:
getUserId in interface SubscriptionModel
Returns:
the user id of this subscription

setUserId

public void setUserId(long userId)
Description copied from interface: SubscriptionModel
Sets the user id of this subscription.

Specified by:
setUserId in interface SubscriptionModel
Parameters:
userId - the user id of this subscription

getUserUuid

public String getUserUuid()
                   throws SystemException
Description copied from interface: SubscriptionModel
Gets the user uuid of this subscription.

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)
Description copied from interface: SubscriptionModel
Sets the user uuid of this subscription.

Specified by:
setUserUuid in interface SubscriptionModel
Parameters:
userUuid - the user uuid of this subscription

getUserName

public String getUserName()
Description copied from interface: SubscriptionModel
Gets the user name of this subscription.

Specified by:
getUserName in interface SubscriptionModel
Returns:
the user name of this subscription

setUserName

public void setUserName(String userName)
Description copied from interface: SubscriptionModel
Sets the user name of this subscription.

Specified by:
setUserName in interface SubscriptionModel
Parameters:
userName - the user name of this subscription

getCreateDate

public Date getCreateDate()
Description copied from interface: SubscriptionModel
Gets the create date of this subscription.

Specified by:
getCreateDate in interface SubscriptionModel
Returns:
the create date of this subscription

setCreateDate

public void setCreateDate(Date createDate)
Description copied from interface: SubscriptionModel
Sets the create date of this subscription.

Specified by:
setCreateDate in interface SubscriptionModel
Parameters:
createDate - the create date of this subscription

getModifiedDate

public Date getModifiedDate()
Description copied from interface: SubscriptionModel
Gets the modified date of this subscription.

Specified by:
getModifiedDate in interface SubscriptionModel
Returns:
the modified date of this subscription

setModifiedDate

public void setModifiedDate(Date modifiedDate)
Description copied from interface: SubscriptionModel
Sets the modified date of this subscription.

Specified by:
setModifiedDate in interface SubscriptionModel
Parameters:
modifiedDate - the modified date of this subscription

getClassName

public String getClassName()
Description copied from interface: SubscriptionModel
Gets the class name of the model instance this subscription is polymorphically associated with.

Specified by:
getClassName in interface SubscriptionModel
Returns:
the class name of the model instance this subscription is polymorphically associated with

getClassNameId

public long getClassNameId()
Description copied from interface: SubscriptionModel
Gets the class name id of this subscription.

Specified by:
getClassNameId in interface SubscriptionModel
Returns:
the class name id of this subscription

setClassNameId

public void setClassNameId(long classNameId)
Description copied from interface: SubscriptionModel
Sets the class name id of this subscription.

Specified by:
setClassNameId in interface SubscriptionModel
Parameters:
classNameId - the class name id of this subscription

getClassPK

public long getClassPK()
Description copied from interface: SubscriptionModel
Gets the class p k of this subscription.

Specified by:
getClassPK in interface SubscriptionModel
Returns:
the class p k of this subscription

setClassPK

public void setClassPK(long classPK)
Description copied from interface: SubscriptionModel
Sets the class p k of this subscription.

Specified by:
setClassPK in interface SubscriptionModel
Parameters:
classPK - the class p k of this subscription

getFrequency

public String getFrequency()
Description copied from interface: SubscriptionModel
Gets the frequency of this subscription.

Specified by:
getFrequency in interface SubscriptionModel
Returns:
the frequency of this subscription

setFrequency

public void setFrequency(String frequency)
Description copied from interface: SubscriptionModel
Sets the frequency of this subscription.

Specified by:
setFrequency in interface SubscriptionModel
Parameters:
frequency - the frequency of this subscription

toEscapedModel

public Subscription toEscapedModel()
Description copied from interface: SubscriptionModel
Gets a copy of this subscription as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface SubscriptionModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

isNew

public 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<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
Determines 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
Determines 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
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

public 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<Subscription>
Specified by:
setEscapedModel in interface SubscriptionModel
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

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

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<Subscription>
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 to retrieve the expando bridge attributes from
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

toString

public String toString()
Specified by:
toString in interface SubscriptionModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Gets 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

getWrappedSubscription

public Subscription getWrappedSubscription()

Liferay 6.0.5