com.liferay.portlet.shopping.model
Interface ShoppingCouponModel

All Superinterfaces:

AuditedModel, BaseModel<ShoppingCoupon>, ClassedModel, Cloneable, Comparable<ShoppingCoupon>, GroupedModel, Serializable

All Known Subinterfaces:

ShoppingCoupon

All Known Implementing Classes:

ShoppingCouponWrapper

@ProviderType
public interface ShoppingCouponModel
extends BaseModel<ShoppingCoupon>, GroupedModel

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

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

See Also:

ShoppingCoupon, ShoppingCouponImpl, ShoppingCouponModelImpl

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(ShoppingCoupon shoppingCoupon)
boolean	getActive() Returns the active of this shopping coupon.
String	getCode() Returns the code of this shopping coupon.
long	getCompanyId() Returns the company ID of this shopping coupon.
long	getCouponId() Returns the coupon ID of this shopping coupon.
Date	getCreateDate() Returns the create date of this shopping coupon.
String	getDescription() Returns the description of this shopping coupon.
double	getDiscount() Returns the discount of this shopping coupon.
String	getDiscountType() Returns the discount type of this shopping coupon.
Date	getEndDate() Returns the end date of this shopping coupon.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getGroupId() Returns the group ID of this shopping coupon.
String	getLimitCategories() Returns the limit categories of this shopping coupon.
String	getLimitSkus() Returns the limit skus of this shopping coupon.
double	getMinOrder() Returns the min order of this shopping coupon.
Date	getModifiedDate() Returns the modified date of this shopping coupon.
String	getName() Returns the name of this shopping coupon.
long	getPrimaryKey() Returns the primary key of this shopping coupon.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
Date	getStartDate() Returns the start date of this shopping coupon.
long	getUserId() Returns the user ID of this shopping coupon.
String	getUserName() Returns the user name of this shopping coupon.
String	getUserUuid() Returns the user uuid of this shopping coupon.
int	hashCode()
boolean	isActive() Returns true if this shopping coupon is active.
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	setActive(boolean active) Sets whether this shopping coupon is active.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setCode(String code) Sets the code of this shopping coupon.
void	setCompanyId(long companyId) Sets the company ID of this shopping coupon.
void	setCouponId(long couponId) Sets the coupon ID of this shopping coupon.
void	setCreateDate(Date createDate) Sets the create date of this shopping coupon.
void	setDescription(String description) Sets the description of this shopping coupon.
void	setDiscount(double discount) Sets the discount of this shopping coupon.
void	setDiscountType(String discountType) Sets the discount type of this shopping coupon.
void	setEndDate(Date endDate) Sets the end date of this shopping coupon.
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	setGroupId(long groupId) Sets the group ID of this shopping coupon.
void	setLimitCategories(String limitCategories) Sets the limit categories of this shopping coupon.
void	setLimitSkus(String limitSkus) Sets the limit skus of this shopping coupon.
void	setMinOrder(double minOrder) Sets the min order of this shopping coupon.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this shopping coupon.
void	setName(String name) Sets the name of this shopping coupon.
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 shopping coupon.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setStartDate(Date startDate) Sets the start date of this shopping coupon.
void	setUserId(long userId) Sets the user ID of this shopping coupon.
void	setUserName(String userName) Sets the user name of this shopping coupon.
void	setUserUuid(String userUuid) Sets the user uuid of this shopping coupon.
CacheModel<ShoppingCoupon>	toCacheModel() Returns a cache model object for this entity used by entity cache.
ShoppingCoupon	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
ShoppingCoupon	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 shopping coupon.

Returns:

the primary key of this shopping coupon

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this shopping coupon.

Parameters:

primaryKey - the primary key of this shopping coupon

getCouponId

long getCouponId()

Returns the coupon ID of this shopping coupon.

Returns:

the coupon ID of this shopping coupon

setCouponId

void setCouponId(long couponId)

Sets the coupon ID of this shopping coupon.

Parameters:

couponId - the coupon ID of this shopping coupon

getGroupId

long getGroupId()

Returns the group ID of this shopping coupon.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this shopping coupon

setGroupId

void setGroupId(long groupId)

Sets the group ID of this shopping coupon.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this shopping coupon

getCompanyId

long getCompanyId()

Returns the company ID of this shopping coupon.

Specified by:

getCompanyId in interface AuditedModel

Returns:

the company ID of this shopping coupon

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this shopping coupon.

Specified by:

setCompanyId in interface AuditedModel

Parameters:

companyId - the company ID of this shopping coupon

getUserId

long getUserId()

Returns the user ID of this shopping coupon.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this shopping coupon

setUserId

void setUserId(long userId)

Sets the user ID of this shopping coupon.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this shopping coupon

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this shopping coupon.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this shopping coupon

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this shopping coupon.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this shopping coupon

getUserName

@AutoEscape
String getUserName()

Returns the user name of this shopping coupon.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this shopping coupon

setUserName

void setUserName(String userName)

Sets the user name of this shopping coupon.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this shopping coupon

getCreateDate

Date getCreateDate()

Returns the create date of this shopping coupon.

Specified by:

getCreateDate in interface AuditedModel

Returns:

the create date of this shopping coupon

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this shopping coupon.

Specified by:

setCreateDate in interface AuditedModel

Parameters:

createDate - the create date of this shopping coupon

getModifiedDate

Date getModifiedDate()

Returns the modified date of this shopping coupon.

Specified by:

getModifiedDate in interface AuditedModel

Returns:

the modified date of this shopping coupon

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this shopping coupon.

Specified by:

setModifiedDate in interface AuditedModel

Parameters:

modifiedDate - the modified date of this shopping coupon

getCode

@AutoEscape
String getCode()

Returns the code of this shopping coupon.

Returns:

the code of this shopping coupon

setCode

void setCode(String code)

Sets the code of this shopping coupon.

Parameters:

code - the code of this shopping coupon

getName

@AutoEscape
String getName()

Returns the name of this shopping coupon.

Returns:

the name of this shopping coupon

setName

void setName(String name)

Sets the name of this shopping coupon.

Parameters:

name - the name of this shopping coupon

getDescription

@AutoEscape
String getDescription()

Returns the description of this shopping coupon.

Returns:

the description of this shopping coupon

setDescription

void setDescription(String description)

Sets the description of this shopping coupon.

Parameters:

description - the description of this shopping coupon

getStartDate

Date getStartDate()

Returns the start date of this shopping coupon.

Returns:

the start date of this shopping coupon

setStartDate

void setStartDate(Date startDate)

Sets the start date of this shopping coupon.

Parameters:

startDate - the start date of this shopping coupon

getEndDate

Date getEndDate()

Returns the end date of this shopping coupon.

Returns:

the end date of this shopping coupon

setEndDate

void setEndDate(Date endDate)

Sets the end date of this shopping coupon.

Parameters:

endDate - the end date of this shopping coupon

getActive

boolean getActive()

Returns the active of this shopping coupon.

Returns:

the active of this shopping coupon

isActive

boolean isActive()

Returns true if this shopping coupon is active.

Returns:

true if this shopping coupon is active; false otherwise

setActive

void setActive(boolean active)

Sets whether this shopping coupon is active.

Parameters:

active - the active of this shopping coupon

getLimitCategories

@AutoEscape
String getLimitCategories()

Returns the limit categories of this shopping coupon.

Returns:

the limit categories of this shopping coupon

setLimitCategories

void setLimitCategories(String limitCategories)

Sets the limit categories of this shopping coupon.

Parameters:

limitCategories - the limit categories of this shopping coupon

getLimitSkus

@AutoEscape
String getLimitSkus()

Returns the limit skus of this shopping coupon.

Returns:

the limit skus of this shopping coupon

setLimitSkus

void setLimitSkus(String limitSkus)

Sets the limit skus of this shopping coupon.

Parameters:

limitSkus - the limit skus of this shopping coupon

getMinOrder

double getMinOrder()

Returns the min order of this shopping coupon.

Returns:

the min order of this shopping coupon

setMinOrder

void setMinOrder(double minOrder)

Sets the min order of this shopping coupon.

Parameters:

minOrder - the min order of this shopping coupon

getDiscount

double getDiscount()

Returns the discount of this shopping coupon.

Returns:

the discount of this shopping coupon

setDiscount

void setDiscount(double discount)

Sets the discount of this shopping coupon.

Parameters:

discount - the discount of this shopping coupon

getDiscountType

@AutoEscape
String getDiscountType()

Returns the discount type of this shopping coupon.

Returns:

the discount type of this shopping coupon

setDiscountType

void setDiscountType(String discountType)

Sets the discount type of this shopping coupon.

Parameters:

discountType - the discount type of this shopping coupon

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

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

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

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

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

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

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

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

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

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<ShoppingCoupon>

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(ShoppingCoupon shoppingCoupon)

Specified by:

compareTo in interface Comparable<ShoppingCoupon>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<ShoppingCoupon> toCacheModel()

Description copied from interface: BaseModel

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

Specified by:

toCacheModel in interface BaseModel<ShoppingCoupon>

Returns:

the cache model object

toEscapedModel

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

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

ShoppingCoupon toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<ShoppingCoupon>

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

Returns:

the XML representation of this model instance