Liferay 6.0-ee

com.liferay.portal.model.impl
Class PortletModelImpl

java.lang.Object
  extended by com.liferay.portal.model.impl.BaseModelImpl<Portlet>
      extended by com.liferay.portal.model.impl.PortletModelImpl
All Implemented Interfaces:
BaseModel<Portlet>, PortletModel, Serializable, Cloneable, Comparable<Portlet>
Direct Known Subclasses:
PortletImpl

public class PortletModelImpl
extends BaseModelImpl<Portlet>
implements PortletModel

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

This implementation and its corresponding interface PortletModel 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 class directly. All methods that expect a portlet model instance should use the Portlet interface instead.

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

Field Summary
static String DATA_SOURCE
           
static boolean ENTITY_CACHE_ENABLED
           
static boolean FINDER_CACHE_ENABLED
           
static long LOCK_EXPIRATION_TIME
           
static String SESSION_FACTORY
           
static Object[][] TABLE_COLUMNS
           
static String TABLE_NAME
           
static String TABLE_SQL_CREATE
           
static String TABLE_SQL_DROP
           
static String TX_MANAGER
           
 
Constructor Summary
PortletModelImpl()
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Portlet portlet)
           
 boolean equals(Object obj)
           
 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.
 long getOriginalCompanyId()
           
 String getOriginalPortletId()
           
 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.
 void setActive(boolean active)
          Sets whether this {$entity.humanName} is active.
 void setCompanyId(long companyId)
          Sets the company id of this portlet.
 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 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 entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
static Portlet toModel(PortletSoap soapModel)
          Converts the soap model instance into a normal model instance.
static List<Portlet> toModels(PortletSoap[] soapModels)
          Converts the soap model instances into normal model instances.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 
Methods inherited from class com.liferay.portal.model.impl.BaseModelImpl
isCachedModel, isEscapedModel, isNew, setCachedModel, setEscapedModel, setNew
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.liferay.portal.model.PortletModel
isCachedModel, isEscapedModel, isNew, setCachedModel, setEscapedModel, setNew
 

Field Detail

TABLE_NAME

public static final String TABLE_NAME
See Also:
Constant Field Values

TABLE_COLUMNS

public static final Object[][] TABLE_COLUMNS

TABLE_SQL_CREATE

public static final String TABLE_SQL_CREATE
See Also:
Constant Field Values

TABLE_SQL_DROP

public static final String TABLE_SQL_DROP
See Also:
Constant Field Values

DATA_SOURCE

public static final String DATA_SOURCE
See Also:
Constant Field Values

SESSION_FACTORY

public static final String SESSION_FACTORY
See Also:
Constant Field Values

TX_MANAGER

public static final String TX_MANAGER
See Also:
Constant Field Values

ENTITY_CACHE_ENABLED

public static final boolean ENTITY_CACHE_ENABLED

FINDER_CACHE_ENABLED

public static final boolean FINDER_CACHE_ENABLED

LOCK_EXPIRATION_TIME

public static final long LOCK_EXPIRATION_TIME
Constructor Detail

PortletModelImpl

public PortletModelImpl()
Method Detail

toModel

public static Portlet toModel(PortletSoap soapModel)
Converts the soap model instance into a normal model instance.

Parameters:
soapModel - the soap model instance to convert
Returns:
the normal model instance

toModels

public static List<Portlet> toModels(PortletSoap[] soapModels)
Converts the soap model instances into normal model instances.

Parameters:
soapModels - the soap model instances to convert
Returns:
the normal model instances

getPrimaryKey

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

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

setPrimaryKey

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

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

getPrimaryKeyObj

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

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

getId

public long getId()
Description copied from interface: PortletModel
Gets the id of this portlet.

Specified by:
getId in interface PortletModel
Returns:
the id of this portlet

setId

public void setId(long id)
Description copied from interface: PortletModel
Sets the id of this portlet.

Specified by:
setId in interface PortletModel
Parameters:
id - the id of this portlet

getCompanyId

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

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

setCompanyId

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

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

getOriginalCompanyId

public long getOriginalCompanyId()

getPortletId

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

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

setPortletId

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

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

getOriginalPortletId

public String getOriginalPortletId()

getRoles

public String getRoles()
Description copied from interface: PortletModel
Gets the roles of this portlet.

Specified by:
getRoles in interface PortletModel
Returns:
the roles of this portlet

setRoles

public void setRoles(String roles)
Description copied from interface: PortletModel
Sets the roles of this portlet.

Specified by:
setRoles in interface PortletModel
Parameters:
roles - the roles of this portlet

getActive

public boolean getActive()
Description copied from interface: PortletModel
Gets the active of this portlet.

Specified by:
getActive in interface PortletModel
Returns:
the active of this portlet

isActive

public boolean isActive()
Description copied from interface: PortletModel
Determines whether this portlet is active.

Specified by:
isActive in interface PortletModel
Returns:
whether this portlet is active

setActive

public void setActive(boolean active)
Description copied from interface: PortletModel
Sets whether this {$entity.humanName} is active.

Specified by:
setActive in interface PortletModel
Parameters:
active - the active of this portlet

toEscapedModel

public Portlet toEscapedModel()
Description copied from interface: BaseModel
Gets a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<Portlet>
Specified by:
toEscapedModel in interface PortletModel
Overrides:
toEscapedModel in class BaseModelImpl<Portlet>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

getExpandoBridge

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

Specified by:
getExpandoBridge in interface BaseModel<Portlet>
Specified by:
getExpandoBridge in interface PortletModel
Overrides:
getExpandoBridge in class BaseModelImpl<Portlet>
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<Portlet>
Specified by:
setExpandoBridgeAttributes in interface PortletModel
Overrides:
setExpandoBridgeAttributes in class BaseModelImpl<Portlet>
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<Portlet>
Specified by:
clone in interface PortletModel
Specified by:
clone in class BaseModelImpl<Portlet>
Returns:
the shallow clone of this model instance

compareTo

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

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

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

toString

public String toString()
Specified by:
toString in interface PortletModel
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<Portlet>
Specified by:
toXmlString in interface PortletModel
Returns:
the XML representation of this model instance

Liferay 6.0-ee