Liferay 6.0-ee

com.liferay.portlet.shopping.model
Interface ShoppingCartModel

All Superinterfaces:
BaseModel<ShoppingCart>, Cloneable, Comparable<ShoppingCart>, Serializable
All Known Subinterfaces:
ShoppingCart
All Known Implementing Classes:
ShoppingCartImpl, ShoppingCartModelImpl, ShoppingCartWrapper

public interface ShoppingCartModel
extends BaseModel<ShoppingCart>

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

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

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

See Also:
ShoppingCart, ShoppingCartImpl, ShoppingCartModelImpl
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(ShoppingCart shoppingCart)
           
 int getAltShipping()
          Gets the alt shipping of this shopping cart.
 long getCartId()
          Gets the cart id of this shopping cart.
 long getCompanyId()
          Gets the company id of this shopping cart.
 String getCouponCodes()
          Gets the coupon codes of this shopping cart.
 Date getCreateDate()
          Gets the create date of this shopping cart.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getGroupId()
          Gets the group id of this shopping cart.
 boolean getInsure()
          Gets the insure of this shopping cart.
 String getItemIds()
          Gets the item ids of this shopping cart.
 Date getModifiedDate()
          Gets the modified date of this shopping cart.
 long getPrimaryKey()
          Gets the primary key of this shopping cart.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 long getUserId()
          Gets the user id of this shopping cart.
 String getUserName()
          Gets the user name of this shopping cart.
 String getUserUuid()
          Gets the user uuid of this shopping cart.
 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 isInsure()
          Determines whether this shopping cart is insure.
 boolean isNew()
          Determines if this model instance does not yet exist in the database.
 void setAltShipping(int altShipping)
          Sets the alt shipping of this shopping cart.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setCartId(long cartId)
          Sets the cart id of this shopping cart.
 void setCompanyId(long companyId)
          Sets the company id of this shopping cart.
 void setCouponCodes(String couponCodes)
          Sets the coupon codes of this shopping cart.
 void setCreateDate(Date createDate)
          Sets the create date of this shopping cart.
 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 cart.
 void setInsure(boolean insure)
          Sets whether this {$entity.humanName} is insure.
 void setItemIds(String itemIds)
          Sets the item ids of this shopping cart.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this shopping cart.
 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 cart
 void setUserId(long userId)
          Sets the user id of this shopping cart.
 void setUserName(String userName)
          Sets the user name of this shopping cart.
 void setUserUuid(String userUuid)
          Sets the user uuid of this shopping cart.
 ShoppingCart toEscapedModel()
          Gets a copy of this entity 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 cart.

Returns:
the primary key of this shopping cart

setPrimaryKey

void setPrimaryKey(long pk)
Sets the primary key of this shopping cart

Parameters:
pk - the primary key of this shopping cart

getCartId

long getCartId()
Gets the cart id of this shopping cart.

Returns:
the cart id of this shopping cart

setCartId

void setCartId(long cartId)
Sets the cart id of this shopping cart.

Parameters:
cartId - the cart id of this shopping cart

getGroupId

long getGroupId()
Gets the group id of this shopping cart.

Returns:
the group id of this shopping cart

setGroupId

void setGroupId(long groupId)
Sets the group id of this shopping cart.

Parameters:
groupId - the group id of this shopping cart

getCompanyId

long getCompanyId()
Gets the company id of this shopping cart.

Returns:
the company id of this shopping cart

setCompanyId

void setCompanyId(long companyId)
Sets the company id of this shopping cart.

Parameters:
companyId - the company id of this shopping cart

getUserId

long getUserId()
Gets the user id of this shopping cart.

Returns:
the user id of this shopping cart

setUserId

void setUserId(long userId)
Sets the user id of this shopping cart.

Parameters:
userId - the user id of this shopping cart

getUserUuid

String getUserUuid()
                   throws SystemException
Gets the user uuid of this shopping cart.

Returns:
the user uuid of this shopping cart
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this shopping cart.

Parameters:
userUuid - the user uuid of this shopping cart

getUserName

@AutoEscape
String getUserName()
Gets the user name of this shopping cart.

Returns:
the user name of this shopping cart

setUserName

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

Parameters:
userName - the user name of this shopping cart

getCreateDate

Date getCreateDate()
Gets the create date of this shopping cart.

Returns:
the create date of this shopping cart

setCreateDate

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

Parameters:
createDate - the create date of this shopping cart

getModifiedDate

Date getModifiedDate()
Gets the modified date of this shopping cart.

Returns:
the modified date of this shopping cart

setModifiedDate

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

Parameters:
modifiedDate - the modified date of this shopping cart

getItemIds

@AutoEscape
String getItemIds()
Gets the item ids of this shopping cart.

Returns:
the item ids of this shopping cart

setItemIds

void setItemIds(String itemIds)
Sets the item ids of this shopping cart.

Parameters:
itemIds - the item ids of this shopping cart

getCouponCodes

@AutoEscape
String getCouponCodes()
Gets the coupon codes of this shopping cart.

Returns:
the coupon codes of this shopping cart

setCouponCodes

void setCouponCodes(String couponCodes)
Sets the coupon codes of this shopping cart.

Parameters:
couponCodes - the coupon codes of this shopping cart

getAltShipping

int getAltShipping()
Gets the alt shipping of this shopping cart.

Returns:
the alt shipping of this shopping cart

setAltShipping

void setAltShipping(int altShipping)
Sets the alt shipping of this shopping cart.

Parameters:
altShipping - the alt shipping of this shopping cart

getInsure

boolean getInsure()
Gets the insure of this shopping cart.

Returns:
the insure of this shopping cart

isInsure

boolean isInsure()
Determines whether this shopping cart is insure.

Returns:
whether this shopping cart is insure

setInsure

void setInsure(boolean insure)
Sets whether this {$entity.humanName} is insure.

Parameters:
insure - the insure of this shopping cart

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<ShoppingCart>
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<ShoppingCart>
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<ShoppingCart>
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<ShoppingCart>
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<ShoppingCart>
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<ShoppingCart>
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<ShoppingCart>
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<ShoppingCart>
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<ShoppingCart>
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<ShoppingCart>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(ShoppingCart shoppingCart)
Specified by:
compareTo in interface Comparable<ShoppingCart>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toEscapedModel

ShoppingCart toEscapedModel()
Description copied from interface: BaseModel
Gets a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<ShoppingCart>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

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

Liferay 6.0-ee