Liferay 6.0.5

com.liferay.portlet.shopping.model
Interface ShoppingCategoryModel

All Superinterfaces:
BaseModel<ShoppingCategory>, Cloneable, Comparable<ShoppingCategory>, Serializable
All Known Subinterfaces:
ShoppingCategory
All Known Implementing Classes:
ShoppingCategoryImpl, ShoppingCategoryModelImpl, ShoppingCategoryWrapper

public interface ShoppingCategoryModel
extends BaseModel<ShoppingCategory>

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

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

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

See Also:
ShoppingCategory, ShoppingCategoryImpl, ShoppingCategoryModelImpl
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(ShoppingCategory shoppingCategory)
           
 long getCategoryId()
          Gets the category id of this shopping category.
 long getCompanyId()
          Gets the company id of this shopping category.
 Date getCreateDate()
          Gets the create date of this shopping category.
 String getDescription()
          Gets the description of this shopping category.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getGroupId()
          Gets the group id of this shopping category.
 Date getModifiedDate()
          Gets the modified date of this shopping category.
 String getName()
          Gets the name of this shopping category.
 long getParentCategoryId()
          Gets the parent category id of this shopping category.
 long getPrimaryKey()
          Gets the primary key of this shopping category.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 long getUserId()
          Gets the user id of this shopping category.
 String getUserName()
          Gets the user name of this shopping category.
 String getUserUuid()
          Gets the user uuid of this shopping category.
 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 isNew()
          Determines if this model instance does not yet exist in the database.
 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 category.
 void setCompanyId(long companyId)
          Sets the company id of this shopping category.
 void setCreateDate(Date createDate)
          Sets the create date of this shopping category.
 void setDescription(String description)
          Sets the description of this shopping category.
 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 category.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this shopping category.
 void setName(String name)
          Sets the name of this shopping category.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentCategoryId(long parentCategoryId)
          Sets the parent category id of this shopping category.
 void setPrimaryKey(long pk)
          Sets the primary key of this shopping category
 void setUserId(long userId)
          Sets the user id of this shopping category.
 void setUserName(String userName)
          Sets the user name of this shopping category.
 void setUserUuid(String userUuid)
          Sets the user uuid of this shopping category.
 ShoppingCategory toEscapedModel()
          Gets a copy of this shopping category 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 category.

Returns:
the primary key of this shopping category

setPrimaryKey

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

Parameters:
pk - the primary key of this shopping category

getCategoryId

long getCategoryId()
Gets the category id of this shopping category.

Returns:
the category id of this shopping category

setCategoryId

void setCategoryId(long categoryId)
Sets the category id of this shopping category.

Parameters:
categoryId - the category id of this shopping category

getGroupId

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

Returns:
the group id of this shopping category

setGroupId

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

Parameters:
groupId - the group id of this shopping category

getCompanyId

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

Returns:
the company id of this shopping category

setCompanyId

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

Parameters:
companyId - the company id of this shopping category

getUserId

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

Returns:
the user id of this shopping category

setUserId

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

Parameters:
userId - the user id of this shopping category

getUserUuid

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

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

setUserUuid

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

Parameters:
userUuid - the user uuid of this shopping category

getUserName

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

Returns:
the user name of this shopping category

setUserName

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

Parameters:
userName - the user name of this shopping category

getCreateDate

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

Returns:
the create date of this shopping category

setCreateDate

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

Parameters:
createDate - the create date of this shopping category

getModifiedDate

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

Returns:
the modified date of this shopping category

setModifiedDate

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

Parameters:
modifiedDate - the modified date of this shopping category

getParentCategoryId

long getParentCategoryId()
Gets the parent category id of this shopping category.

Returns:
the parent category id of this shopping category

setParentCategoryId

void setParentCategoryId(long parentCategoryId)
Sets the parent category id of this shopping category.

Parameters:
parentCategoryId - the parent category id of this shopping category

getName

@AutoEscape
String getName()
Gets the name of this shopping category.

Returns:
the name of this shopping category

setName

void setName(String name)
Sets the name of this shopping category.

Parameters:
name - the name of this shopping category

getDescription

@AutoEscape
String getDescription()
Gets the description of this shopping category.

Returns:
the description of this shopping category

setDescription

void setDescription(String description)
Sets the description of this shopping category.

Parameters:
description - the description of this shopping category

toEscapedModel

ShoppingCategory toEscapedModel()
Gets a copy of this shopping category 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<ShoppingCategory>
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<ShoppingCategory>
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<ShoppingCategory>
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<ShoppingCategory>
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<ShoppingCategory>
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<ShoppingCategory>
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<ShoppingCategory>
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<ShoppingCategory>
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<ShoppingCategory>
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<ShoppingCategory>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(ShoppingCategory shoppingCategory)
Specified by:
compareTo in interface Comparable<ShoppingCategory>

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

Liferay 6.0.5