Liferay 6.2.0

com.liferay.portal.model
Interface PortletModel

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

@ProviderType
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.

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

Method Summary
abstract  Object clone()
          Creates a shallow clone of this model instance.
abstract  int compareTo(Portlet portlet)
           
abstract  boolean getActive()
          Returns the active of this portlet.
abstract  long getCompanyId()
          Returns the company ID of this portlet.
abstract  ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
abstract  long getId()
          Returns the ID of this portlet.
abstract  String getPortletId()
          Returns the portlet ID of this portlet.
abstract  long getPrimaryKey()
          Returns the primary key of this portlet.
abstract  Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
abstract  String getRoles()
          Returns the roles of this portlet.
abstract  int hashCode()
           
abstract  boolean isActive()
          Returns true if this portlet is active.
abstract  boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
abstract  boolean isEscapedModel()
          Returns true if this model instance is escaped.
abstract  boolean isNew()
          Returns true if this model instance does not yet exist in the database.
abstract  void setActive(boolean active)
          Sets whether this portlet is active.
abstract  void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
abstract  void setCompanyId(long companyId)
          Sets the company ID of this portlet.
abstract  void setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
abstract  void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
abstract  void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
abstract  void setId(long id)
          Sets the ID of this portlet.
abstract  void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
abstract  void setPortletId(String portletId)
          Sets the portlet ID of this portlet.
abstract  void setPrimaryKey(long primaryKey)
          Sets the primary key of this portlet.
abstract  void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
abstract  void setRoles(String roles)
          Sets the roles of this portlet.
abstract  CacheModel<Portlet> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
abstract  Portlet toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
abstract  String toString()
           
abstract  Portlet toUnescapedModel()
           
abstract  String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.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

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.

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

Liferay 6.2.0