@ProviderType public interface PortletModel extends BaseModel<Portlet>, MVCCModel, ShardedModel
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.
Portlet,
com.liferay.portal.model.impl.PortletImpl,
com.liferay.portal.model.impl.PortletModelImpl| Modifier and Type | Method and Description |
|---|---|
Object |
clone()
Creates a shallow clone of this model instance.
|
int |
compareTo(Portlet portlet) |
boolean |
getActive()
Returns the active of this portlet.
|
long |
getCompanyId()
Returns the company ID of this portlet.
|
ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance.
|
long |
getId()
Returns the ID of this portlet.
|
long |
getMvccVersion()
Returns the mvcc version of this portlet.
|
String |
getPortletId()
Returns the portlet ID of this portlet.
|
long |
getPrimaryKey()
Returns the primary key of this portlet.
|
Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance.
|
String |
getRoles()
Returns the roles of this portlet.
|
int |
hashCode() |
boolean |
isActive()
Returns
true if this portlet is active. |
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 |
setActive(boolean active)
Sets whether this portlet 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 |
setExpandoBridgeAttributes(BaseModel<?> baseModel) |
void |
setExpandoBridgeAttributes(ExpandoBridge expandoBridge) |
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 |
setMvccVersion(long mvccVersion)
Sets the mvcc version 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 primaryKey)
Sets the primary key of this portlet.
|
void |
setPrimaryKeyObj(Serializable primaryKeyObj)
Sets the primary key of this model instance.
|
void |
setRoles(String roles)
Sets the roles of this portlet.
|
CacheModel<Portlet> |
toCacheModel()
Returns a cache model object for this entity used by entity cache.
|
Portlet |
toEscapedModel()
Returns a copy of this entity as an escaped model instance by wrapping it
with an
AutoEscapeBeanHandler. |
String |
toString() |
Portlet |
toUnescapedModel() |
String |
toXmlString()
Returns the XML representation of this model instance.
|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributesgetModelClass, getModelClassNamelong getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey - the primary key of this portletlong getMvccVersion()
getMvccVersion in interface MVCCModelvoid setMvccVersion(long mvccVersion)
setMvccVersion in interface MVCCModelmvccVersion - the mvcc version of this portletlong getId()
void setId(long id)
id - the ID of this portletlong getCompanyId()
getCompanyId in interface ShardedModelvoid setCompanyId(long companyId)
setCompanyId in interface ShardedModelcompanyId - the company ID of this portlet@AutoEscape String getPortletId()
void setPortletId(String portletId)
portletId - the portlet ID of this portlet@AutoEscape String getRoles()
void setRoles(String roles)
roles - the roles of this portletboolean getActive()
boolean isActive()
true if this portlet is active.true if this portlet is active; false otherwisevoid setActive(boolean active)
active - the active of this portletboolean isNew()
BaseModeltrue if this model instance does not yet exist in
the database.void setNew(boolean n)
BaseModelboolean isCachedModel()
BaseModeltrue if this model instance was retrieved from the
entity cache.isCachedModel in interface BaseModel<Portlet>true if this model instance was retrieved from the
entity cache; false otherwiseBaseModel.setCachedModel(boolean)void setCachedModel(boolean cachedModel)
BaseModelsetCachedModel in interface BaseModel<Portlet>cachedModel - whether this model instance was retrieved from the
entity cacheEntityCacheboolean isEscapedModel()
BaseModeltrue if this model instance is escaped.isEscapedModel in interface BaseModel<Portlet>true if this model instance is escaped;
false otherwiseSerializable getPrimaryKeyObj()
BaseModelgetPrimaryKeyObj in interface BaseModel<Portlet>getPrimaryKeyObj in interface ClassedModelvoid setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModelsetPrimaryKeyObj in interface BaseModel<Portlet>setPrimaryKeyObj in interface ClassedModelprimaryKeyObj - the primary key of this model instanceExpandoBridge getExpandoBridge()
BaseModelgetExpandoBridge in interface BaseModel<Portlet>getExpandoBridge in interface ClassedModelvoid setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes in interface BaseModel<Portlet>void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes in interface BaseModel<Portlet>void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModelsetExpandoBridgeAttributes in interface BaseModel<Portlet>serviceContext - the service context to be appliedServiceContext.getExpandoBridgeAttributes()Object clone()
BaseModelint compareTo(Portlet portlet)
compareTo in interface Comparable<Portlet>CacheModel<Portlet> toCacheModel()
BaseModeltoCacheModel in interface BaseModel<Portlet>Portlet toEscapedModel()
BaseModelAutoEscapeBeanHandler.toEscapedModel in interface BaseModel<Portlet>AutoEscapeBeanHandlerPortlet toUnescapedModel()
toUnescapedModel in interface BaseModel<Portlet>String toXmlString()
BaseModeltoXmlString in interface BaseModel<Portlet>