Package com.liferay.portal.kernel.model
Interface PortletModel
- All Superinterfaces:
BaseModel<Portlet>
,ClassedModel
,Cloneable
,Comparable<Portlet>
,MVCCModel
,Serializable
,ShardedModel
- All Known Subinterfaces:
Portlet
- All Known Implementing Classes:
PortletWrapper
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 com.liferay.portal.model.impl.PortletModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portal.model.impl.PortletImpl
.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the active of this portlet.long
Returns the company ID of this portlet.long
getId()
Returns the ID of this portlet.long
Returns the mvcc version of this portlet.Returns the portlet ID of this portlet.long
Returns the primary key of this portlet.getRoles()
Returns the roles of this portlet.boolean
isActive()
Returnstrue
if this portlet is active.void
setActive
(boolean active) Sets whether this portlet is active.void
setCompanyId
(long companyId) Sets the company ID of this portlet.void
setId
(long id) Sets the ID of this portlet.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this portlet.void
setPortletId
(String portletId) Sets the portlet ID of this portlet.void
setPrimaryKey
(long primaryKey) Sets the primary key of this portlet.void
Sets the roles of this portlet.default String
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this portlet.- Returns:
- the primary key of this portlet
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this portlet.- Parameters:
primaryKey
- the primary key of this portlet
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this portlet.- Specified by:
getMvccVersion
in interfaceMVCCModel
- Returns:
- the mvcc version of this portlet
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this portlet.- Specified by:
setMvccVersion
in interfaceMVCCModel
- Parameters:
mvccVersion
- the mvcc version of this portlet
-
getId
long getId()Returns 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()Returns the company ID of this portlet.- Specified by:
getCompanyId
in interfaceShardedModel
- Returns:
- the company ID of this portlet
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this portlet.- Specified by:
setCompanyId
in interfaceShardedModel
- Parameters:
companyId
- the company ID of this portlet
-
getPortletId
Returns the portlet ID of this portlet.- Returns:
- the portlet ID of this portlet
-
setPortletId
Sets the portlet ID of this portlet.- Parameters:
portletId
- the portlet ID of this portlet
-
getRoles
Returns the roles of this portlet.- Returns:
- the roles of this portlet
-
setRoles
Sets the roles of this portlet.- Parameters:
roles
- the roles of this portlet
-
getActive
boolean getActive()Returns the active of this portlet.- Returns:
- the active of this portlet
-
isActive
boolean isActive()Returnstrue
if this portlet is active.- Returns:
true
if this portlet is active;false
otherwise
-
setActive
void setActive(boolean active) Sets whether this portlet is active.- Parameters:
active
- the active of this portlet
-
cloneWithOriginalValues
Portlet cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<Portlet>
-
toXmlString
-