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

@ProviderType
public interface PortletModel
extends BaseModel<Portlet>, MVCCModel, ShardedModel

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.

Author:

Brian Wing Shun Chan

See Also:

Portlet, PortletImpl, PortletModelImpl

{$generated.description}

Method Summary

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.

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Method Detail

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 interface MVCCModel

Returns:

the mvcc version of this portlet

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this portlet.

Specified by:

setMvccVersion in interface MVCCModel

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 interface ShardedModel

Returns:

the company ID of this portlet

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this portlet.

Specified by:

setCompanyId in interface ShardedModel

Parameters:

companyId - the company ID of this portlet

getPortletId

@AutoEscape
String getPortletId()

Returns 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()

Returns 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()

Returns the active of this portlet.

Returns:

the active of this portlet

isActive

boolean isActive()

Returns true 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

isNew

boolean isNew()

Description copied from interface: BaseModel

Returns true 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

Returns true 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

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<Portlet>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<Portlet>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<Portlet>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<Portlet>

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<Portlet>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<Portlet>

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 be applied

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

toCacheModel

CacheModel<Portlet> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<Portlet>

Returns:

the cache model object

toEscapedModel

Portlet toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<Portlet>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

Portlet toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<Portlet>

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<Portlet>

Returns:

the XML representation of this model instance