com.liferay.portal.model
Interface PortletItemModel

All Superinterfaces:

BaseModel<PortletItem>, Cloneable, Comparable<PortletItem>, Serializable

All Known Subinterfaces:

PortletItem

All Known Implementing Classes:

PortletItemImpl, PortletItemModelImpl, PortletItemWrapper

public interface PortletItemModel
extends BaseModel<PortletItem>

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

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

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

See Also:

PortletItem, PortletItemImpl, PortletItemModelImpl

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(PortletItem portletItem)
String	getClassName() Gets the class name of the model instance this portlet item is polymorphically associated with.
long	getClassNameId() Gets the class name id of this portlet item.
long	getCompanyId() Gets the company id of this portlet item.
Date	getCreateDate() Gets the create date of this portlet item.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this portlet item.
Date	getModifiedDate() Gets the modified date of this portlet item.
String	getName() Gets the name of this portlet item.
String	getPortletId() Gets the portlet id of this portlet item.
long	getPortletItemId() Gets the portlet item id of this portlet item.
long	getPrimaryKey() Gets the primary key of this portlet item.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getUserId() Gets the user id of this portlet item.
String	getUserName() Gets the user name of this portlet item.
String	getUserUuid() Gets the user uuid of this portlet 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	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	setClassNameId(long classNameId) Sets the class name id of this portlet item.
void	setCompanyId(long companyId) Sets the company id of this portlet item.
void	setCreateDate(Date createDate) Sets the create date of this portlet 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	setGroupId(long groupId) Sets the group id of this portlet item.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this portlet item.
void	setName(String name) Sets the name of this portlet item.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPortletId(String portletId) Sets the portlet id of this portlet item.
void	setPortletItemId(long portletItemId) Sets the portlet item id of this portlet item.
void	setPrimaryKey(long pk) Sets the primary key of this portlet item
void	setUserId(long userId) Sets the user id of this portlet item.
void	setUserName(String userName) Sets the user name of this portlet item.
void	setUserUuid(String userUuid) Sets the user uuid of this portlet item.
PortletItem	toEscapedModel() Gets a copy of this portlet 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 portlet item.

Returns:

the primary key of this portlet item

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this portlet item

Parameters:

pk - the primary key of this portlet item

getPortletItemId

long getPortletItemId()

Gets the portlet item id of this portlet item.

Returns:

the portlet item id of this portlet item

setPortletItemId

void setPortletItemId(long portletItemId)

Sets the portlet item id of this portlet item.

Parameters:

portletItemId - the portlet item id of this portlet item

getGroupId

long getGroupId()

Gets the group id of this portlet item.

Returns:

the group id of this portlet item

setGroupId

void setGroupId(long groupId)

Sets the group id of this portlet item.

Parameters:

groupId - the group id of this portlet item

getCompanyId

long getCompanyId()

Gets the company id of this portlet item.

Returns:

the company id of this portlet item

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this portlet item.

Parameters:

companyId - the company id of this portlet item

getUserId

long getUserId()

Gets the user id of this portlet item.

Returns:

the user id of this portlet item

setUserId

void setUserId(long userId)

Sets the user id of this portlet item.

Parameters:

userId - the user id of this portlet item

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this portlet item.

Returns:

the user uuid of this portlet item

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this portlet item.

Parameters:

userUuid - the user uuid of this portlet item

getUserName

@AutoEscape
String getUserName()

Gets the user name of this portlet item.

Returns:

the user name of this portlet item

setUserName

void setUserName(String userName)

Sets the user name of this portlet item.

Parameters:

userName - the user name of this portlet item

getCreateDate

Date getCreateDate()

Gets the create date of this portlet item.

Returns:

the create date of this portlet item

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this portlet item.

Parameters:

createDate - the create date of this portlet item

getModifiedDate

Date getModifiedDate()

Gets the modified date of this portlet item.

Returns:

the modified date of this portlet item

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this portlet item.

Parameters:

modifiedDate - the modified date of this portlet item

getName

@AutoEscape
String getName()

Gets the name of this portlet item.

Returns:

the name of this portlet item

setName

void setName(String name)

Sets the name of this portlet item.

Parameters:

name - the name of this portlet item

getPortletId

@AutoEscape
String getPortletId()

Gets the portlet id of this portlet item.

Returns:

the portlet id of this portlet item

setPortletId

void setPortletId(String portletId)

Sets the portlet id of this portlet item.

Parameters:

portletId - the portlet id of this portlet item

getClassName

String getClassName()

Gets the class name of the model instance this portlet item is polymorphically associated with.

Returns:

the class name of the model instance this portlet item is polymorphically associated with

getClassNameId

long getClassNameId()

Gets the class name id of this portlet item.

Returns:

the class name id of this portlet item

setClassNameId

void setClassNameId(long classNameId)

Sets the class name id of this portlet item.

Parameters:

classNameId - the class name id of this portlet item

toEscapedModel

PortletItem toEscapedModel()

Gets a copy of this portlet 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<PortletItem>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(PortletItem portletItem)

Specified by:

compareTo in interface Comparable<PortletItem>

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

Returns:

the XML representation of this model instance