Liferay 6.0.5

com.liferay.portal.model
Class PortletItemWrapper

java.lang.Object
  extended by com.liferay.portal.model.PortletItemWrapper
All Implemented Interfaces:
BaseModel<PortletItem>, PortletItem, PortletItemModel, Serializable, Cloneable, Comparable<PortletItem>

public class PortletItemWrapper
extends Object
implements PortletItem

This class is a wrapper for PortletItem.

See Also:
PortletItem, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
PortletItemWrapper(PortletItem portletItem)
           
 
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.
 PortletItem getWrappedPortletItem()
           
 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.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PortletItemWrapper

public PortletItemWrapper(PortletItem portletItem)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Description copied from interface: PortletItemModel
Gets the primary key of this portlet item.

Specified by:
getPrimaryKey in interface PortletItemModel
Returns:
the primary key of this portlet item

setPrimaryKey

public void setPrimaryKey(long pk)
Description copied from interface: PortletItemModel
Sets the primary key of this portlet item

Specified by:
setPrimaryKey in interface PortletItemModel
Parameters:
pk - the primary key of this portlet item

getPortletItemId

public long getPortletItemId()
Description copied from interface: PortletItemModel
Gets the portlet item id of this portlet item.

Specified by:
getPortletItemId in interface PortletItemModel
Returns:
the portlet item id of this portlet item

setPortletItemId

public void setPortletItemId(long portletItemId)
Description copied from interface: PortletItemModel
Sets the portlet item id of this portlet item.

Specified by:
setPortletItemId in interface PortletItemModel
Parameters:
portletItemId - the portlet item id of this portlet item

getGroupId

public long getGroupId()
Description copied from interface: PortletItemModel
Gets the group id of this portlet item.

Specified by:
getGroupId in interface PortletItemModel
Returns:
the group id of this portlet item

setGroupId

public void setGroupId(long groupId)
Description copied from interface: PortletItemModel
Sets the group id of this portlet item.

Specified by:
setGroupId in interface PortletItemModel
Parameters:
groupId - the group id of this portlet item

getCompanyId

public long getCompanyId()
Description copied from interface: PortletItemModel
Gets the company id of this portlet item.

Specified by:
getCompanyId in interface PortletItemModel
Returns:
the company id of this portlet item

setCompanyId

public void setCompanyId(long companyId)
Description copied from interface: PortletItemModel
Sets the company id of this portlet item.

Specified by:
setCompanyId in interface PortletItemModel
Parameters:
companyId - the company id of this portlet item

getUserId

public long getUserId()
Description copied from interface: PortletItemModel
Gets the user id of this portlet item.

Specified by:
getUserId in interface PortletItemModel
Returns:
the user id of this portlet item

setUserId

public void setUserId(long userId)
Description copied from interface: PortletItemModel
Sets the user id of this portlet item.

Specified by:
setUserId in interface PortletItemModel
Parameters:
userId - the user id of this portlet item

getUserUuid

public String getUserUuid()
                   throws SystemException
Description copied from interface: PortletItemModel
Gets the user uuid of this portlet item.

Specified by:
getUserUuid in interface PortletItemModel
Returns:
the user uuid of this portlet item
Throws:
SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(String userUuid)
Description copied from interface: PortletItemModel
Sets the user uuid of this portlet item.

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

getUserName

public String getUserName()
Description copied from interface: PortletItemModel
Gets the user name of this portlet item.

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

setUserName

public void setUserName(String userName)
Description copied from interface: PortletItemModel
Sets the user name of this portlet item.

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

getCreateDate

public Date getCreateDate()
Description copied from interface: PortletItemModel
Gets the create date of this portlet item.

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

setCreateDate

public void setCreateDate(Date createDate)
Description copied from interface: PortletItemModel
Sets the create date of this portlet item.

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

getModifiedDate

public Date getModifiedDate()
Description copied from interface: PortletItemModel
Gets the modified date of this portlet item.

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

setModifiedDate

public void setModifiedDate(Date modifiedDate)
Description copied from interface: PortletItemModel
Sets the modified date of this portlet item.

Specified by:
setModifiedDate in interface PortletItemModel
Parameters:
modifiedDate - the modified date of this portlet item

getName

public String getName()
Description copied from interface: PortletItemModel
Gets the name of this portlet item.

Specified by:
getName in interface PortletItemModel
Returns:
the name of this portlet item

setName

public void setName(String name)
Description copied from interface: PortletItemModel
Sets the name of this portlet item.

Specified by:
setName in interface PortletItemModel
Parameters:
name - the name of this portlet item

getPortletId

public String getPortletId()
Description copied from interface: PortletItemModel
Gets the portlet id of this portlet item.

Specified by:
getPortletId in interface PortletItemModel
Returns:
the portlet id of this portlet item

setPortletId

public void setPortletId(String portletId)
Description copied from interface: PortletItemModel
Sets the portlet id of this portlet item.

Specified by:
setPortletId in interface PortletItemModel
Parameters:
portletId - the portlet id of this portlet item

getClassName

public String getClassName()
Description copied from interface: PortletItemModel
Gets the class name of the model instance this portlet item is polymorphically associated with.

Specified by:
getClassName in interface PortletItemModel
Returns:
the class name of the model instance this portlet item is polymorphically associated with

getClassNameId

public long getClassNameId()
Description copied from interface: PortletItemModel
Gets the class name id of this portlet item.

Specified by:
getClassNameId in interface PortletItemModel
Returns:
the class name id of this portlet item

setClassNameId

public void setClassNameId(long classNameId)
Description copied from interface: PortletItemModel
Sets the class name id of this portlet item.

Specified by:
setClassNameId in interface PortletItemModel
Parameters:
classNameId - the class name id of this portlet item

toEscapedModel

public PortletItem toEscapedModel()
Description copied from interface: PortletItemModel
Gets a copy of this portlet item as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface PortletItemModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

isNew

public 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>
Specified by:
isNew in interface PortletItemModel
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

public 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>
Specified by:
setNew in interface PortletItemModel
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

public 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>
Specified by:
isCachedModel in interface PortletItemModel
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

public 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>
Specified by:
setCachedModel in interface PortletItemModel
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

public boolean isEscapedModel()
Description copied from interface: BaseModel
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<PortletItem>
Specified by:
isEscapedModel in interface PortletItemModel
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

public 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>
Specified by:
setEscapedModel in interface PortletItemModel
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<PortletItem>
Specified by:
getPrimaryKeyObj in interface PortletItemModel
Returns:
the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<PortletItem>
Specified by:
getExpandoBridge in interface PortletItemModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

public 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>
Specified by:
setExpandoBridgeAttributes in interface PortletItemModel
Parameters:
serviceContext - the service context to retrieve the expando bridge attributes from
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

public Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<PortletItem>
Specified by:
clone in interface PortletItemModel
Overrides:
clone in class Object
Returns:
the shallow clone of this model instance

compareTo

public int compareTo(PortletItem portletItem)
Specified by:
compareTo in interface PortletItemModel
Specified by:
compareTo in interface Comparable<PortletItem>

hashCode

public int hashCode()
Specified by:
hashCode in interface PortletItemModel
Overrides:
hashCode in class Object

toString

public String toString()
Specified by:
toString in interface PortletItemModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Gets the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<PortletItem>
Specified by:
toXmlString in interface PortletItemModel
Returns:
the XML representation of this model instance

getWrappedPortletItem

public PortletItem getWrappedPortletItem()

Liferay 6.0.5