Liferay 6.0-ee-sp2

com.liferay.portal.model
Interface PortletItemModel

All Superinterfaces:
AuditedModel, BaseModel<PortletItem>, ClassedModel, Cloneable, Comparable<PortletItem>, GroupedModel, Serializable
All Known Subinterfaces:
PortletItem
All Known Implementing Classes:
PortletItemWrapper

public interface PortletItemModel
extends BaseModel<PortletItem>, GroupedModel

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.

See Also:
PortletItem, PortletItemImpl, PortletItemModelImpl

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()
          Returns 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()
          Returns 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()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isNew()
          Returns true 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 primaryKey)
          Sets the primary key of this portlet item
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 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.
 CacheModel<PortletItem> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 PortletItem toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
resetOriginalValues
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

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 primaryKey)
Sets the primary key of this portlet item

Parameters:
primaryKey - 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.

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

setGroupId

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

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

getCompanyId

long getCompanyId()
Gets the company ID of this portlet item.

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

setCompanyId

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

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

getUserId

long getUserId()
Gets the user ID of this portlet item.

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

setUserId

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

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

getUserUuid

String getUserUuid()
                   throws SystemException
Gets the user uuid of this portlet item.

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

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

getUserName

@AutoEscape
String getUserName()
Gets the user name of this portlet item.

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

setUserName

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

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

getCreateDate

Date getCreateDate()
Gets the create date of this portlet item.

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

setCreateDate

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

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

getModifiedDate

Date getModifiedDate()
Gets the modified date of this portlet item.

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

setModifiedDate

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

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

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<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
Returns true 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
Returns true 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
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<PortletItem>
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<PortletItem>
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<PortletItem>
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<PortletItem>
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<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

toCacheModel

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

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

toEscapedModel

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

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

Liferay 6.0-ee-sp2