Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface PortletPreferencesModel

All Superinterfaces:
BaseModel<PortletPreferences>, ClassedModel, Cloneable, Comparable<PortletPreferences>, Serializable
All Known Subinterfaces:
PortletPreferences
All Known Implementing Classes:
PortletPreferencesWrapper

public interface PortletPreferencesModel
extends BaseModel<PortletPreferences>

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

This interface and its corresponding implementation PortletPreferencesModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in PortletPreferencesImpl.

See Also:
PortletPreferences, PortletPreferencesImpl, PortletPreferencesModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(PortletPreferences portletPreferences)
           
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getOwnerId()
          Returns the owner ID of this portlet preferences.
 int getOwnerType()
          Returns the owner type of this portlet preferences.
 long getPlid()
          Returns the plid of this portlet preferences.
 String getPortletId()
          Returns the portlet ID of this portlet preferences.
 long getPortletPreferencesId()
          Returns the portlet preferences ID of this portlet preferences.
 String getPreferences()
          Returns the preferences of this portlet preferences.
 long getPrimaryKey()
          Returns the primary key of this portlet preferences.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 int hashCode()
           
 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 setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setOwnerId(long ownerId)
          Sets the owner ID of this portlet preferences.
 void setOwnerType(int ownerType)
          Sets the owner type of this portlet preferences.
 void setPlid(long plid)
          Sets the plid of this portlet preferences.
 void setPortletId(String portletId)
          Sets the portlet ID of this portlet preferences.
 void setPortletPreferencesId(long portletPreferencesId)
          Sets the portlet preferences ID of this portlet preferences.
 void setPreferences(String preferences)
          Sets the preferences of this portlet preferences.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this portlet preferences.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 CacheModel<PortletPreferences> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 PortletPreferences toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 PortletPreferences toUnescapedModel()
           
 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 preferences.

Returns:
the primary key of this portlet preferences

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this portlet preferences.

Parameters:
primaryKey - the primary key of this portlet preferences

getPortletPreferencesId

long getPortletPreferencesId()
Returns the portlet preferences ID of this portlet preferences.

Returns:
the portlet preferences ID of this portlet preferences

setPortletPreferencesId

void setPortletPreferencesId(long portletPreferencesId)
Sets the portlet preferences ID of this portlet preferences.

Parameters:
portletPreferencesId - the portlet preferences ID of this portlet preferences

getOwnerId

long getOwnerId()
Returns the owner ID of this portlet preferences.

Returns:
the owner ID of this portlet preferences

setOwnerId

void setOwnerId(long ownerId)
Sets the owner ID of this portlet preferences.

Parameters:
ownerId - the owner ID of this portlet preferences

getOwnerType

int getOwnerType()
Returns the owner type of this portlet preferences.

Returns:
the owner type of this portlet preferences

setOwnerType

void setOwnerType(int ownerType)
Sets the owner type of this portlet preferences.

Parameters:
ownerType - the owner type of this portlet preferences

getPlid

long getPlid()
Returns the plid of this portlet preferences.

Returns:
the plid of this portlet preferences

setPlid

void setPlid(long plid)
Sets the plid of this portlet preferences.

Parameters:
plid - the plid of this portlet preferences

getPortletId

@AutoEscape
String getPortletId()
Returns the portlet ID of this portlet preferences.

Returns:
the portlet ID of this portlet preferences

setPortletId

void setPortletId(String portletId)
Sets the portlet ID of this portlet preferences.

Parameters:
portletId - the portlet ID of this portlet preferences

getPreferences

@AutoEscape
String getPreferences()
Returns the preferences of this portlet preferences.

Returns:
the preferences of this portlet preferences

setPreferences

void setPreferences(String preferences)
Sets the preferences of this portlet preferences.

Parameters:
preferences - the preferences of this portlet preferences

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<PortletPreferences>
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<PortletPreferences>
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<PortletPreferences>
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<PortletPreferences>
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<PortletPreferences>
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<PortletPreferences>
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<PortletPreferences>
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<PortletPreferences>
Specified by:
getExpandoBridge in interface ClassedModel
Returns:
the expando bridge for this model instance

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<PortletPreferences>
Parameters:
serviceContext - the service context
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<PortletPreferences>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(PortletPreferences portletPreferences)
Specified by:
compareTo in interface Comparable<PortletPreferences>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<PortletPreferences> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<PortletPreferences>
Returns:
the cache model object

toEscapedModel

PortletPreferences 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<PortletPreferences>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

PortletPreferences toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<PortletPreferences>

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<PortletPreferences>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3