com.liferay.portlet.shopping.model
Interface ShoppingCouponModel

All Superinterfaces:

BaseModel<ShoppingCoupon>, java.lang.Cloneable, java.lang.Comparable<ShoppingCoupon>, java.io.Serializable

All Known Subinterfaces:

ShoppingCoupon

All Known Implementing Classes:

ShoppingCouponWrapper

public interface ShoppingCouponModel
extends BaseModel<ShoppingCoupon>

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 com.liferay.portlet.shopping.model.impl.ShoppingCouponModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portlet.shopping.model.impl.ShoppingCouponImpl.

Never modify or reference this interface directly. All methods that expect a shopping coupon model instance should use the ShoppingCoupon interface instead.

Author:

Brian Wing Shun Chan

See Also:

ShoppingCoupon, com.liferay.portlet.shopping.model.impl.ShoppingCouponImpl, com.liferay.portlet.shopping.model.impl.ShoppingCouponModelImpl

Generated:

Method Summary

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

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this shopping coupon.

Returns:

the primary key of this shopping coupon

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this shopping coupon

Parameters:

pk - the primary key of this shopping coupon

getCouponId

long getCouponId()

Gets 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()

Gets the group id of this shopping coupon.

Returns:

the group id of this shopping coupon

setGroupId

void setGroupId(long groupId)

Sets the group id of this shopping coupon.

Parameters:

groupId - the group id of this shopping coupon

getCompanyId

long getCompanyId()

Gets the company id of this shopping coupon.

Returns:

the company id of this shopping coupon

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this shopping coupon.

Parameters:

companyId - the company id of this shopping coupon

getUserId

long getUserId()

Gets the user id of this shopping coupon.

Returns:

the user id of this shopping coupon

setUserId

void setUserId(long userId)

Sets the user id of this shopping coupon.

Parameters:

userId - the user id of this shopping coupon

getUserUuid

java.lang.String getUserUuid()
                             throws SystemException

Gets the user uuid of this shopping coupon.

Returns:

the user uuid of this shopping coupon

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this shopping coupon.

Parameters:

userUuid - the user uuid of this shopping coupon

getUserName

@AutoEscape
java.lang.String getUserName()

Gets the user name of this shopping coupon.

Returns:

the user name of this shopping coupon

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this shopping coupon.

Parameters:

userName - the user name of this shopping coupon

getCreateDate

java.util.Date getCreateDate()

Gets the create date of this shopping coupon.

Returns:

the create date of this shopping coupon

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this shopping coupon.

Parameters:

createDate - the create date of this shopping coupon

getModifiedDate

java.util.Date getModifiedDate()

Gets the modified date of this shopping coupon.

Returns:

the modified date of this shopping coupon

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this shopping coupon.

Parameters:

modifiedDate - the modified date of this shopping coupon

getCode

@AutoEscape
java.lang.String getCode()

Gets the code of this shopping coupon.

Returns:

the code of this shopping coupon

setCode

void setCode(java.lang.String code)

Sets the code of this shopping coupon.

Parameters:

code - the code of this shopping coupon

getName

@AutoEscape
java.lang.String getName()

Gets the name of this shopping coupon.

Returns:

the name of this shopping coupon

setName

void setName(java.lang.String name)

Sets the name of this shopping coupon.

Parameters:

name - the name of this shopping coupon

getDescription

@AutoEscape
java.lang.String getDescription()

Gets the description of this shopping coupon.

Returns:

the description of this shopping coupon

setDescription

void setDescription(java.lang.String description)

Sets the description of this shopping coupon.

Parameters:

description - the description of this shopping coupon

getStartDate

java.util.Date getStartDate()

Gets the start date of this shopping coupon.

Returns:

the start date of this shopping coupon

setStartDate

void setStartDate(java.util.Date startDate)

Sets the start date of this shopping coupon.

Parameters:

startDate - the start date of this shopping coupon

getEndDate

java.util.Date getEndDate()

Gets the end date of this shopping coupon.

Returns:

the end date of this shopping coupon

setEndDate

void setEndDate(java.util.Date endDate)

Sets the end date of this shopping coupon.

Parameters:

endDate - the end date of this shopping coupon

getActive

boolean getActive()

Gets the active of this shopping coupon.

Returns:

the active of this shopping coupon

isActive

boolean isActive()

Determines if this shopping coupon is active.

Returns:

true if this shopping coupon is active; false otherwise

setActive

void setActive(boolean active)

Sets whether this {$entity.humanName} is active.

Parameters:

active - the active of this shopping coupon

getLimitCategories

@AutoEscape
java.lang.String getLimitCategories()

Gets the limit categories of this shopping coupon.

Returns:

the limit categories of this shopping coupon

setLimitCategories

void setLimitCategories(java.lang.String limitCategories)

Sets the limit categories of this shopping coupon.

Parameters:

limitCategories - the limit categories of this shopping coupon

getLimitSkus

@AutoEscape
java.lang.String getLimitSkus()

Gets the limit skus of this shopping coupon.

Returns:

the limit skus of this shopping coupon

setLimitSkus

void setLimitSkus(java.lang.String limitSkus)

Sets the limit skus of this shopping coupon.

Parameters:

limitSkus - the limit skus of this shopping coupon

getMinOrder

double getMinOrder()

Gets 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()

Gets 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
java.lang.String getDiscountType()

Gets the discount type of this shopping coupon.

Returns:

the discount type of this shopping coupon

setDiscountType

void setDiscountType(java.lang.String discountType)

Sets the discount type of this shopping coupon.

Parameters:

discountType - the discount type of this shopping coupon

toEscapedModel

ShoppingCoupon toEscapedModel()

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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<ShoppingCoupon>

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

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

java.io.Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<ShoppingCoupon>

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

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

Parameters:

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

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

java.lang.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 java.lang.Comparable<ShoppingCoupon>

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXmlString

java.lang.String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<ShoppingCoupon>

Returns:

the XML representation of this model instance