Liferay 6.0.5

com.liferay.portal.model
Interface PortletModel

All Superinterfaces:
BaseModel<Portlet>, Cloneable, Comparable<Portlet>, Serializable
All Known Subinterfaces:
Portlet
All Known Implementing Classes:
PortletImpl, PortletModelImpl, PortletWrapper

public interface PortletModel
extends BaseModel<Portlet>

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

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

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

See Also:
Portlet, PortletImpl, PortletModelImpl
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(Portlet portlet)
           
 boolean getActive()
          Gets the active of this portlet.
 long getCompanyId()
          Gets the company id of this portlet.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getId()
          Gets the id of this portlet.
 String getPortletId()
          Gets the portlet id of this portlet.
 long getPrimaryKey()
          Gets the primary key of this portlet.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 String getRoles()
          Gets the roles of this portlet.
 int hashCode()
           
 boolean isActive()
          Determines whether this portlet is active.
 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 setActive(boolean active)
          Sets whether this {$entity.humanName} is active.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setCompanyId(long companyId)
          Sets the company id of this portlet.
 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 setId(long id)
          Sets the id of this portlet.
 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.
 void setPrimaryKey(long pk)
          Sets the primary key of this portlet
 void setRoles(String roles)
          Sets the roles of this portlet.
 Portlet toEscapedModel()
          Gets a copy of this portlet 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.

Returns:
the primary key of this portlet

setPrimaryKey

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

Parameters:
pk - the primary key of this portlet

getId

long getId()
Gets the id of this portlet.

Returns:
the id of this portlet

setId

void setId(long id)
Sets the id of this portlet.

Parameters:
id - the id of this portlet

getCompanyId

long getCompanyId()
Gets the company id of this portlet.

Returns:
the company id of this portlet

setCompanyId

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

Parameters:
companyId - the company id of this portlet

getPortletId

@AutoEscape
String getPortletId()
Gets the portlet id of this portlet.

Returns:
the portlet id of this portlet

setPortletId

void setPortletId(String portletId)
Sets the portlet id of this portlet.

Parameters:
portletId - the portlet id of this portlet

getRoles

@AutoEscape
String getRoles()
Gets the roles of this portlet.

Returns:
the roles of this portlet

setRoles

void setRoles(String roles)
Sets the roles of this portlet.

Parameters:
roles - the roles of this portlet

getActive

boolean getActive()
Gets the active of this portlet.

Returns:
the active of this portlet

isActive

boolean isActive()
Determines whether this portlet is active.

Returns:
whether this portlet is active

setActive

void setActive(boolean active)
Sets whether this {$entity.humanName} is active.

Parameters:
active - the active of this portlet

toEscapedModel

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

compareTo

int compareTo(Portlet portlet)
Specified by:
compareTo in interface Comparable<Portlet>

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

Liferay 6.0.5