com.liferay.portlet.shopping.model
Interface ShoppingItemModel

All Superinterfaces:

BaseModel<ShoppingItem>, Cloneable, Comparable<ShoppingItem>, Serializable

All Known Subinterfaces:

ShoppingItem

All Known Implementing Classes:

ShoppingItemImpl, ShoppingItemModelImpl, ShoppingItemWrapper

public interface ShoppingItemModel
extends BaseModel<ShoppingItem>

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

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

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

See Also:

ShoppingItem, ShoppingItemImpl, ShoppingItemModelImpl

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(ShoppingItem shoppingItem)
long	getCategoryId() Gets the category id of this shopping item.
long	getCompanyId() Gets the company id of this shopping item.
Date	getCreateDate() Gets the create date of this shopping item.
String	getDescription() Gets the description of this shopping item.
double	getDiscount() Gets the discount of this shopping item.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
boolean	getFeatured() Gets the featured of this shopping item.
boolean	getFields() Gets the fields of this shopping item.
String	getFieldsQuantities() Gets the fields quantities of this shopping item.
long	getGroupId() Gets the group id of this shopping item.
long	getItemId() Gets the item id of this shopping item.
boolean	getLargeImage() Gets the large image of this shopping item.
long	getLargeImageId() Gets the large image id of this shopping item.
String	getLargeImageURL() Gets the large image u r l of this shopping item.
int	getMaxQuantity() Gets the max quantity of this shopping item.
boolean	getMediumImage() Gets the medium image of this shopping item.
long	getMediumImageId() Gets the medium image id of this shopping item.
String	getMediumImageURL() Gets the medium image u r l of this shopping item.
int	getMinQuantity() Gets the min quantity of this shopping item.
Date	getModifiedDate() Gets the modified date of this shopping item.
String	getName() Gets the name of this shopping item.
double	getPrice() Gets the price of this shopping item.
long	getPrimaryKey() Gets the primary key of this shopping item.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
String	getProperties() Gets the properties of this shopping item.
boolean	getRequiresShipping() Gets the requires shipping of this shopping item.
boolean	getSale() Gets the sale of this shopping item.
double	getShipping() Gets the shipping of this shopping item.
String	getSku() Gets the sku of this shopping item.
boolean	getSmallImage() Gets the small image of this shopping item.
long	getSmallImageId() Gets the small image id of this shopping item.
String	getSmallImageURL() Gets the small image u r l of this shopping item.
int	getStockQuantity() Gets the stock quantity of this shopping item.
boolean	getTaxable() Gets the taxable of this shopping item.
long	getUserId() Gets the user id of this shopping item.
String	getUserName() Gets the user name of this shopping item.
String	getUserUuid() Gets the user uuid of this shopping item.
boolean	getUseShippingFormula() Gets the use shipping formula of this shopping item.
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	isFeatured() Determines whether this shopping item is featured.
boolean	isFields() Determines whether this shopping item is fields.
boolean	isLargeImage() Determines whether this shopping item is large image.
boolean	isMediumImage() Determines whether this shopping item is medium image.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isRequiresShipping() Determines whether this shopping item is requires shipping.
boolean	isSale() Determines whether this shopping item is sale.
boolean	isSmallImage() Determines whether this shopping item is small image.
boolean	isTaxable() Determines whether this shopping item is taxable.
boolean	isUseShippingFormula() Determines whether this shopping item is use shipping formula.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setCategoryId(long categoryId) Sets the category id of this shopping item.
void	setCompanyId(long companyId) Sets the company id of this shopping item.
void	setCreateDate(Date createDate) Sets the create date of this shopping item.
void	setDescription(String description) Sets the description of this shopping item.
void	setDiscount(double discount) Sets the discount of this shopping item.
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	setFeatured(boolean featured) Sets whether this {$entity.humanName} is featured.
void	setFields(boolean fields) Sets whether this {$entity.humanName} is fields.
void	setFieldsQuantities(String fieldsQuantities) Sets the fields quantities of this shopping item.
void	setGroupId(long groupId) Sets the group id of this shopping item.
void	setItemId(long itemId) Sets the item id of this shopping item.
void	setLargeImage(boolean largeImage) Sets whether this {$entity.humanName} is large image.
void	setLargeImageId(long largeImageId) Sets the large image id of this shopping item.
void	setLargeImageURL(String largeImageURL) Sets the large image u r l of this shopping item.
void	setMaxQuantity(int maxQuantity) Sets the max quantity of this shopping item.
void	setMediumImage(boolean mediumImage) Sets whether this {$entity.humanName} is medium image.
void	setMediumImageId(long mediumImageId) Sets the medium image id of this shopping item.
void	setMediumImageURL(String mediumImageURL) Sets the medium image u r l of this shopping item.
void	setMinQuantity(int minQuantity) Sets the min quantity of this shopping item.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this shopping item.
void	setName(String name) Sets the name of this shopping item.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrice(double price) Sets the price of this shopping item.
void	setPrimaryKey(long pk) Sets the primary key of this shopping item
void	setProperties(String properties) Sets the properties of this shopping item.
void	setRequiresShipping(boolean requiresShipping) Sets whether this {$entity.humanName} is requires shipping.
void	setSale(boolean sale) Sets whether this {$entity.humanName} is sale.
void	setShipping(double shipping) Sets the shipping of this shopping item.
void	setSku(String sku) Sets the sku of this shopping item.
void	setSmallImage(boolean smallImage) Sets whether this {$entity.humanName} is small image.
void	setSmallImageId(long smallImageId) Sets the small image id of this shopping item.
void	setSmallImageURL(String smallImageURL) Sets the small image u r l of this shopping item.
void	setStockQuantity(int stockQuantity) Sets the stock quantity of this shopping item.
void	setTaxable(boolean taxable) Sets whether this {$entity.humanName} is taxable.
void	setUserId(long userId) Sets the user id of this shopping item.
void	setUserName(String userName) Sets the user name of this shopping item.
void	setUserUuid(String userUuid) Sets the user uuid of this shopping item.
void	setUseShippingFormula(boolean useShippingFormula) Sets whether this {$entity.humanName} is use shipping formula.
ShoppingItem	toEscapedModel() Gets a copy of this shopping item 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 shopping item.

Returns:

the primary key of this shopping item

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this shopping item

Parameters:

pk - the primary key of this shopping item

getItemId

long getItemId()

Gets the item id of this shopping item.

Returns:

the item id of this shopping item

setItemId

void setItemId(long itemId)

Sets the item id of this shopping item.

Parameters:

itemId - the item id of this shopping item

getGroupId

long getGroupId()

Gets the group id of this shopping item.

Returns:

the group id of this shopping item

setGroupId

void setGroupId(long groupId)

Sets the group id of this shopping item.

Parameters:

groupId - the group id of this shopping item

getCompanyId

long getCompanyId()

Gets the company id of this shopping item.

Returns:

the company id of this shopping item

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this shopping item.

Parameters:

companyId - the company id of this shopping item

getUserId

long getUserId()

Gets the user id of this shopping item.

Returns:

the user id of this shopping item

setUserId

void setUserId(long userId)

Sets the user id of this shopping item.

Parameters:

userId - the user id of this shopping item

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this shopping item.

Returns:

the user uuid of this shopping item

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this shopping item.

Parameters:

userUuid - the user uuid of this shopping item

getUserName

@AutoEscape
String getUserName()

Gets the user name of this shopping item.

Returns:

the user name of this shopping item

setUserName

void setUserName(String userName)

Sets the user name of this shopping item.

Parameters:

userName - the user name of this shopping item

getCreateDate

Date getCreateDate()

Gets the create date of this shopping item.

Returns:

the create date of this shopping item

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this shopping item.

Parameters:

createDate - the create date of this shopping item

getModifiedDate

Date getModifiedDate()

Gets the modified date of this shopping item.

Returns:

the modified date of this shopping item

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this shopping item.

Parameters:

modifiedDate - the modified date of this shopping item

getCategoryId

long getCategoryId()

Gets the category id of this shopping item.

Returns:

the category id of this shopping item

setCategoryId

void setCategoryId(long categoryId)

Sets the category id of this shopping item.

Parameters:

categoryId - the category id of this shopping item

getSku

@AutoEscape
String getSku()

Gets the sku of this shopping item.

Returns:

the sku of this shopping item

setSku

void setSku(String sku)

Sets the sku of this shopping item.

Parameters:

sku - the sku of this shopping item

getName

@AutoEscape
String getName()

Gets the name of this shopping item.

Returns:

the name of this shopping item

setName

void setName(String name)

Sets the name of this shopping item.

Parameters:

name - the name of this shopping item

getDescription

@AutoEscape
String getDescription()

Gets the description of this shopping item.

Returns:

the description of this shopping item

setDescription

void setDescription(String description)

Sets the description of this shopping item.

Parameters:

description - the description of this shopping item

getProperties

@AutoEscape
String getProperties()

Gets the properties of this shopping item.

Returns:

the properties of this shopping item

setProperties

void setProperties(String properties)

Sets the properties of this shopping item.

Parameters:

properties - the properties of this shopping item

getFields

boolean getFields()

Gets the fields of this shopping item.

Returns:

the fields of this shopping item

isFields

boolean isFields()

Determines whether this shopping item is fields.

Returns:

whether this shopping item is fields

setFields

void setFields(boolean fields)

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

Parameters:

fields - the fields of this shopping item

getFieldsQuantities

@AutoEscape
String getFieldsQuantities()

Gets the fields quantities of this shopping item.

Returns:

the fields quantities of this shopping item

setFieldsQuantities

void setFieldsQuantities(String fieldsQuantities)

Sets the fields quantities of this shopping item.

Parameters:

fieldsQuantities - the fields quantities of this shopping item

getMinQuantity

int getMinQuantity()

Gets the min quantity of this shopping item.

Returns:

the min quantity of this shopping item

setMinQuantity

void setMinQuantity(int minQuantity)

Sets the min quantity of this shopping item.

Parameters:

minQuantity - the min quantity of this shopping item

getMaxQuantity

int getMaxQuantity()

Gets the max quantity of this shopping item.

Returns:

the max quantity of this shopping item

setMaxQuantity

void setMaxQuantity(int maxQuantity)

Sets the max quantity of this shopping item.

Parameters:

maxQuantity - the max quantity of this shopping item

getPrice

double getPrice()

Gets the price of this shopping item.

Returns:

the price of this shopping item

setPrice

void setPrice(double price)

Sets the price of this shopping item.

Parameters:

price - the price of this shopping item

getDiscount

double getDiscount()

Gets the discount of this shopping item.

Returns:

the discount of this shopping item

setDiscount

void setDiscount(double discount)

Sets the discount of this shopping item.

Parameters:

discount - the discount of this shopping item

getTaxable

boolean getTaxable()

Gets the taxable of this shopping item.

Returns:

the taxable of this shopping item

isTaxable

boolean isTaxable()

Determines whether this shopping item is taxable.

Returns:

whether this shopping item is taxable

setTaxable

void setTaxable(boolean taxable)

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

Parameters:

taxable - the taxable of this shopping item

getShipping

double getShipping()

Gets the shipping of this shopping item.

Returns:

the shipping of this shopping item

setShipping

void setShipping(double shipping)

Sets the shipping of this shopping item.

Parameters:

shipping - the shipping of this shopping item

getUseShippingFormula

boolean getUseShippingFormula()

Gets the use shipping formula of this shopping item.

Returns:

the use shipping formula of this shopping item

isUseShippingFormula

boolean isUseShippingFormula()

Determines whether this shopping item is use shipping formula.

Returns:

whether this shopping item is use shipping formula

setUseShippingFormula

void setUseShippingFormula(boolean useShippingFormula)

Sets whether this {$entity.humanName} is use shipping formula.

Parameters:

useShippingFormula - the use shipping formula of this shopping item

getRequiresShipping

boolean getRequiresShipping()

Gets the requires shipping of this shopping item.

Returns:

the requires shipping of this shopping item

isRequiresShipping

boolean isRequiresShipping()

Determines whether this shopping item is requires shipping.

Returns:

whether this shopping item is requires shipping

setRequiresShipping

void setRequiresShipping(boolean requiresShipping)

Sets whether this {$entity.humanName} is requires shipping.

Parameters:

requiresShipping - the requires shipping of this shopping item

getStockQuantity

int getStockQuantity()

Gets the stock quantity of this shopping item.

Returns:

the stock quantity of this shopping item

setStockQuantity

void setStockQuantity(int stockQuantity)

Sets the stock quantity of this shopping item.

Parameters:

stockQuantity - the stock quantity of this shopping item

getFeatured

boolean getFeatured()

Gets the featured of this shopping item.

Returns:

the featured of this shopping item

isFeatured

boolean isFeatured()

Determines whether this shopping item is featured.

Returns:

whether this shopping item is featured

setFeatured

void setFeatured(boolean featured)

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

Parameters:

featured - the featured of this shopping item

getSale

boolean getSale()

Gets the sale of this shopping item.

Returns:

the sale of this shopping item

isSale

boolean isSale()

Determines whether this shopping item is sale.

Returns:

whether this shopping item is sale

setSale

void setSale(boolean sale)

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

Parameters:

sale - the sale of this shopping item

getSmallImage

boolean getSmallImage()

Gets the small image of this shopping item.

Returns:

the small image of this shopping item

isSmallImage

boolean isSmallImage()

Determines whether this shopping item is small image.

Returns:

whether this shopping item is small image

setSmallImage

void setSmallImage(boolean smallImage)

Sets whether this {$entity.humanName} is small image.

Parameters:

smallImage - the small image of this shopping item

getSmallImageId

long getSmallImageId()

Gets the small image id of this shopping item.

Returns:

the small image id of this shopping item

setSmallImageId

void setSmallImageId(long smallImageId)

Sets the small image id of this shopping item.

Parameters:

smallImageId - the small image id of this shopping item

getSmallImageURL

@AutoEscape
String getSmallImageURL()

Gets the small image u r l of this shopping item.

Returns:

the small image u r l of this shopping item

setSmallImageURL

void setSmallImageURL(String smallImageURL)

Sets the small image u r l of this shopping item.

Parameters:

smallImageURL - the small image u r l of this shopping item

getMediumImage

boolean getMediumImage()

Gets the medium image of this shopping item.

Returns:

the medium image of this shopping item

isMediumImage

boolean isMediumImage()

Determines whether this shopping item is medium image.

Returns:

whether this shopping item is medium image

setMediumImage

void setMediumImage(boolean mediumImage)

Sets whether this {$entity.humanName} is medium image.

Parameters:

mediumImage - the medium image of this shopping item

getMediumImageId

long getMediumImageId()

Gets the medium image id of this shopping item.

Returns:

the medium image id of this shopping item

setMediumImageId

void setMediumImageId(long mediumImageId)

Sets the medium image id of this shopping item.

Parameters:

mediumImageId - the medium image id of this shopping item

getMediumImageURL

@AutoEscape
String getMediumImageURL()

Gets the medium image u r l of this shopping item.

Returns:

the medium image u r l of this shopping item

setMediumImageURL

void setMediumImageURL(String mediumImageURL)

Sets the medium image u r l of this shopping item.

Parameters:

mediumImageURL - the medium image u r l of this shopping item

getLargeImage

boolean getLargeImage()

Gets the large image of this shopping item.

Returns:

the large image of this shopping item

isLargeImage

boolean isLargeImage()

Determines whether this shopping item is large image.

Returns:

whether this shopping item is large image

setLargeImage

void setLargeImage(boolean largeImage)

Sets whether this {$entity.humanName} is large image.

Parameters:

largeImage - the large image of this shopping item

getLargeImageId

long getLargeImageId()

Gets the large image id of this shopping item.

Returns:

the large image id of this shopping item

setLargeImageId

void setLargeImageId(long largeImageId)

Sets the large image id of this shopping item.

Parameters:

largeImageId - the large image id of this shopping item

getLargeImageURL

@AutoEscape
String getLargeImageURL()

Gets the large image u r l of this shopping item.

Returns:

the large image u r l of this shopping item

setLargeImageURL

void setLargeImageURL(String largeImageURL)

Sets the large image u r l of this shopping item.

Parameters:

largeImageURL - the large image u r l of this shopping item

toEscapedModel

ShoppingItem toEscapedModel()

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

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(ShoppingItem shoppingItem)

Specified by:

compareTo in interface Comparable<ShoppingItem>

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

Returns:

the XML representation of this model instance