Liferay 6.1.2-ce-ga3

com.liferay.portlet.shopping.model
Interface ShoppingItemModel

All Superinterfaces:
AuditedModel, BaseModel<ShoppingItem>, ClassedModel, Cloneable, Comparable<ShoppingItem>, GroupedModel, Serializable
All Known Subinterfaces:
ShoppingItem
All Known Implementing Classes:
ShoppingItemBaseImpl, ShoppingItemImpl, ShoppingItemModelImpl, ShoppingItemWrapper

public interface ShoppingItemModel
extends BaseModel<ShoppingItem>, GroupedModel

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.

See Also:
ShoppingItem, ShoppingItemImpl, ShoppingItemModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(ShoppingItem shoppingItem)
           
 long getCategoryId()
          Returns the category ID of this shopping item.
 long getCompanyId()
          Returns the company ID of this shopping item.
 Date getCreateDate()
          Returns the create date of this shopping item.
 String getDescription()
          Returns the description of this shopping item.
 double getDiscount()
          Returns the discount of this shopping item.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 boolean getFeatured()
          Returns the featured of this shopping item.
 boolean getFields()
          Returns the fields of this shopping item.
 String getFieldsQuantities()
          Returns the fields quantities of this shopping item.
 long getGroupId()
          Returns the group ID of this shopping item.
 long getItemId()
          Returns the item ID of this shopping item.
 boolean getLargeImage()
          Returns the large image of this shopping item.
 long getLargeImageId()
          Returns the large image ID of this shopping item.
 String getLargeImageURL()
          Returns the large image u r l of this shopping item.
 int getMaxQuantity()
          Returns the max quantity of this shopping item.
 boolean getMediumImage()
          Returns the medium image of this shopping item.
 long getMediumImageId()
          Returns the medium image ID of this shopping item.
 String getMediumImageURL()
          Returns the medium image u r l of this shopping item.
 int getMinQuantity()
          Returns the min quantity of this shopping item.
 Date getModifiedDate()
          Returns the modified date of this shopping item.
 String getName()
          Returns the name of this shopping item.
 double getPrice()
          Returns the price of this shopping item.
 long getPrimaryKey()
          Returns the primary key of this shopping item.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 String getProperties()
          Returns the properties of this shopping item.
 boolean getRequiresShipping()
          Returns the requires shipping of this shopping item.
 boolean getSale()
          Returns the sale of this shopping item.
 double getShipping()
          Returns the shipping of this shopping item.
 String getSku()
          Returns the sku of this shopping item.
 boolean getSmallImage()
          Returns the small image of this shopping item.
 long getSmallImageId()
          Returns the small image ID of this shopping item.
 String getSmallImageURL()
          Returns the small image u r l of this shopping item.
 int getStockQuantity()
          Returns the stock quantity of this shopping item.
 boolean getTaxable()
          Returns the taxable of this shopping item.
 long getUserId()
          Returns the user ID of this shopping item.
 String getUserName()
          Returns the user name of this shopping item.
 String getUserUuid()
          Returns the user uuid of this shopping item.
 boolean getUseShippingFormula()
          Returns the use shipping formula of this shopping item.
 int hashCode()
           
 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 isFeatured()
          Returns true if this shopping item is featured.
 boolean isFields()
          Returns true if this shopping item is fields.
 boolean isLargeImage()
          Returns true if this shopping item is large image.
 boolean isMediumImage()
          Returns true if this shopping item is medium image.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isRequiresShipping()
          Returns true if this shopping item is requires shipping.
 boolean isSale()
          Returns true if this shopping item is sale.
 boolean isSmallImage()
          Returns true if this shopping item is small image.
 boolean isTaxable()
          Returns true if this shopping item is taxable.
 boolean isUseShippingFormula()
          Returns true if 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 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 shopping item is featured.
 void setFields(boolean fields)
          Sets whether this shopping item 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 shopping item 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 shopping item 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 primaryKey)
          Sets the primary key of this shopping item.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setProperties(String properties)
          Sets the properties of this shopping item.
 void setRequiresShipping(boolean requiresShipping)
          Sets whether this shopping item is requires shipping.
 void setSale(boolean sale)
          Sets whether this shopping item 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 shopping item 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 shopping item 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 shopping item is use shipping formula.
 CacheModel<ShoppingItem> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 ShoppingItem toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 ShoppingItem 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 item.

Returns:
the primary key of this shopping item

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this shopping item.

Parameters:
primaryKey - the primary key of this shopping item

getItemId

long getItemId()
Returns 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()
Returns the group ID of this shopping item.

Specified by:
getGroupId in interface GroupedModel
Returns:
the group ID of this shopping item

setGroupId

void setGroupId(long groupId)
Sets the group ID of this shopping item.

Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this shopping item

getCompanyId

long getCompanyId()
Returns the company ID of this shopping item.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this shopping item

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this shopping item.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this shopping item

getUserId

long getUserId()
Returns the user ID of this shopping item.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this shopping item

setUserId

void setUserId(long userId)
Sets the user ID of this shopping item.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this shopping item

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this shopping item.

Specified by:
getUserUuid in interface AuditedModel
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.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this shopping item

getUserName

@AutoEscape
String getUserName()
Returns the user name of this shopping item.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this shopping item

setUserName

void setUserName(String userName)
Sets the user name of this shopping item.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this shopping item

getCreateDate

Date getCreateDate()
Returns the create date of this shopping item.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this shopping item

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this shopping item.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this shopping item

getModifiedDate

Date getModifiedDate()
Returns the modified date of this shopping item.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this shopping item

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this shopping item.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this shopping item

getCategoryId

long getCategoryId()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns the fields of this shopping item.

Returns:
the fields of this shopping item

isFields

boolean isFields()
Returns true if this shopping item is fields.

Returns:
true if this shopping item is fields; false otherwise

setFields

void setFields(boolean fields)
Sets whether this shopping item is fields.

Parameters:
fields - the fields of this shopping item

getFieldsQuantities

@AutoEscape
String getFieldsQuantities()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns the taxable of this shopping item.

Returns:
the taxable of this shopping item

isTaxable

boolean isTaxable()
Returns true if this shopping item is taxable.

Returns:
true if this shopping item is taxable; false otherwise

setTaxable

void setTaxable(boolean taxable)
Sets whether this shopping item is taxable.

Parameters:
taxable - the taxable of this shopping item

getShipping

double getShipping()
Returns 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()
Returns the use shipping formula of this shopping item.

Returns:
the use shipping formula of this shopping item

isUseShippingFormula

boolean isUseShippingFormula()
Returns true if this shopping item is use shipping formula.

Returns:
true if this shopping item is use shipping formula; false otherwise

setUseShippingFormula

void setUseShippingFormula(boolean useShippingFormula)
Sets whether this shopping item is use shipping formula.

Parameters:
useShippingFormula - the use shipping formula of this shopping item

getRequiresShipping

boolean getRequiresShipping()
Returns the requires shipping of this shopping item.

Returns:
the requires shipping of this shopping item

isRequiresShipping

boolean isRequiresShipping()
Returns true if this shopping item is requires shipping.

Returns:
true if this shopping item is requires shipping; false otherwise

setRequiresShipping

void setRequiresShipping(boolean requiresShipping)
Sets whether this shopping item is requires shipping.

Parameters:
requiresShipping - the requires shipping of this shopping item

getStockQuantity

int getStockQuantity()
Returns 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()
Returns the featured of this shopping item.

Returns:
the featured of this shopping item

isFeatured

boolean isFeatured()
Returns true if this shopping item is featured.

Returns:
true if this shopping item is featured; false otherwise

setFeatured

void setFeatured(boolean featured)
Sets whether this shopping item is featured.

Parameters:
featured - the featured of this shopping item

getSale

boolean getSale()
Returns the sale of this shopping item.

Returns:
the sale of this shopping item

isSale

boolean isSale()
Returns true if this shopping item is sale.

Returns:
true if this shopping item is sale; false otherwise

setSale

void setSale(boolean sale)
Sets whether this shopping item is sale.

Parameters:
sale - the sale of this shopping item

getSmallImage

boolean getSmallImage()
Returns the small image of this shopping item.

Returns:
the small image of this shopping item

isSmallImage

boolean isSmallImage()
Returns true if this shopping item is small image.

Returns:
true if this shopping item is small image; false otherwise

setSmallImage

void setSmallImage(boolean smallImage)
Sets whether this shopping item is small image.

Parameters:
smallImage - the small image of this shopping item

getSmallImageId

long getSmallImageId()
Returns 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()
Returns 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()
Returns the medium image of this shopping item.

Returns:
the medium image of this shopping item

isMediumImage

boolean isMediumImage()
Returns true if this shopping item is medium image.

Returns:
true if this shopping item is medium image; false otherwise

setMediumImage

void setMediumImage(boolean mediumImage)
Sets whether this shopping item is medium image.

Parameters:
mediumImage - the medium image of this shopping item

getMediumImageId

long getMediumImageId()
Returns 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()
Returns 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()
Returns the large image of this shopping item.

Returns:
the large image of this shopping item

isLargeImage

boolean isLargeImage()
Returns true if this shopping item is large image.

Returns:
true if this shopping item is large image; false otherwise

setLargeImage

void setLargeImage(boolean largeImage)
Sets whether this shopping item is large image.

Parameters:
largeImage - the large image of this shopping item

getLargeImageId

long getLargeImageId()
Returns 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()
Returns 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

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<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
Returns true 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
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<ShoppingItem>
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<ShoppingItem>
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<ShoppingItem>
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<ShoppingItem>
Specified by:
getExpandoBridge in interface ClassedModel
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
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

toCacheModel

CacheModel<ShoppingItem> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<ShoppingItem>
Returns:
the cache model object

toEscapedModel

ShoppingItem 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<ShoppingItem>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

ShoppingItem toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<ShoppingItem>

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<ShoppingItem>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3