Liferay 6.0-ee

com.liferay.portal.model
Interface PortletPreferencesModel

All Superinterfaces:
BaseModel<PortletPreferences>, Cloneable, Comparable<PortletPreferences>, Serializable
All Known Subinterfaces:
PortletPreferences
All Known Implementing Classes:
PortletPreferencesImpl, PortletPreferencesModelImpl, 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.

Never modify or reference this interface directly. All methods that expect a portlet preferences model instance should use the PortletPreferences interface instead.

See Also:
PortletPreferences, PortletPreferencesImpl, PortletPreferencesModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(PortletPreferences portletPreferences)
           
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getOwnerId()
          Gets the owner id of this portlet preferences.
 int getOwnerType()
          Gets the owner type of this portlet preferences.
 long getPlid()
          Gets the plid of this portlet preferences.
 String getPortletId()
          Gets the portlet id of this portlet preferences.
 long getPortletPreferencesId()
          Gets the portlet preferences id of this portlet preferences.
 String getPreferences()
          Gets the preferences of this portlet preferences.
 long getPrimaryKey()
          Gets the primary key of this portlet preferences.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 int hashCode()
           
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Determines if this model instance is escaped.
 boolean isNew()
          Determines 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 setEscapedModel(boolean escapedModel)
          Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
 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 pk)
          Sets the primary key of this portlet preferences
 PortletPreferences toEscapedModel()
          Gets a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Gets the primary key of this portlet preferences.

Returns:
the primary key of this portlet preferences

setPrimaryKey

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

Parameters:
pk - the primary key of this portlet preferences

getPortletPreferencesId

long getPortletPreferencesId()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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
Determines 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
Determines 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
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<PortletPreferences>
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<PortletPreferences>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<PortletPreferences>
Returns:
the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<PortletPreferences>
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 to retrieve the expando bridge attributes from
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

toEscapedModel

PortletPreferences toEscapedModel()
Description copied from interface: BaseModel
Gets 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

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Gets the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<PortletPreferences>
Returns:
the XML representation of this model instance

Liferay 6.0-ee