com.liferay.portal.model
Interface SubscriptionModel

All Superinterfaces:

BaseModel<Subscription>, Cloneable, Comparable<Subscription>, Serializable

All Known Subinterfaces:

Subscription

All Known Implementing Classes:

SubscriptionImpl, SubscriptionModelImpl, SubscriptionWrapper

public interface SubscriptionModel
extends BaseModel<Subscription>

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.

Never modify or reference this interface directly. All methods that expect a subscription model instance should use the Subscription interface instead.

See Also:

Subscription, SubscriptionImpl, SubscriptionModelImpl

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

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

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this subscription.

Returns:

the primary key of this subscription

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this subscription

Parameters:

pk - the primary key of this subscription

getSubscriptionId

long getSubscriptionId()

Gets 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

getCompanyId

long getCompanyId()

Gets the company id of this subscription.

Returns:

the company id of this subscription

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this subscription.

Parameters:

companyId - the company id of this subscription

getUserId

long getUserId()

Gets the user id of this subscription.

Returns:

the user id of this subscription

setUserId

void setUserId(long userId)

Sets the user id of this subscription.

Parameters:

userId - the user id of this subscription

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this subscription.

Returns:

the user uuid of this subscription

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this subscription.

Parameters:

userUuid - the user uuid of this subscription

getUserName

@AutoEscape
String getUserName()

Gets the user name of this subscription.

Returns:

the user name of this subscription

setUserName

void setUserName(String userName)

Sets the user name of this subscription.

Parameters:

userName - the user name of this subscription

getCreateDate

Date getCreateDate()

Gets the create date of this subscription.

Returns:

the create date of this subscription

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this subscription.

Parameters:

createDate - the create date of this subscription

getModifiedDate

Date getModifiedDate()

Gets the modified date of this subscription.

Returns:

the modified date of this subscription

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this subscription.

Parameters:

modifiedDate - the modified date of this subscription

getClassName

String getClassName()

Gets the class name of the model instance this subscription is polymorphically associated with.

Returns:

the class name of the model instance this subscription is polymorphically associated with

getClassNameId

long getClassNameId()

Gets the class name id of this subscription.

Returns:

the class name id of this subscription

setClassNameId

void setClassNameId(long classNameId)

Sets the class name id of this subscription.

Parameters:

classNameId - the class name id of this subscription

getClassPK

long getClassPK()

Gets the class p k of this subscription.

Returns:

the class p k of this subscription

setClassPK

void setClassPK(long classPK)

Sets the class p k of this subscription.

Parameters:

classPK - the class p k of this subscription

getFrequency

@AutoEscape
String getFrequency()

Gets 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

toEscapedModel

Subscription toEscapedModel()

Gets a copy of this subscription 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<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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<Subscription>

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

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<Subscription>

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

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

Parameters:

serviceContext - the service context to retrieve the expando bridge attributes from

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

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<Subscription>

Returns:

the XML representation of this model instance