Liferay 6.0.5

com.liferay.portal.model
Interface LayoutPrototypeModel

All Superinterfaces:
BaseModel<LayoutPrototype>, Cloneable, Comparable<LayoutPrototype>, Serializable
All Known Subinterfaces:
LayoutPrototype
All Known Implementing Classes:
LayoutPrototypeImpl, LayoutPrototypeModelImpl, LayoutPrototypeWrapper

public interface LayoutPrototypeModel
extends BaseModel<LayoutPrototype>

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

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

Never modify or reference this interface directly. All methods that expect a layout prototype model instance should use the LayoutPrototype interface instead.

See Also:
LayoutPrototype, LayoutPrototypeImpl, LayoutPrototypeModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(LayoutPrototype layoutPrototype)
           
 boolean getActive()
          Gets the active of this layout prototype.
 long getCompanyId()
          Gets the company id of this layout prototype.
 String getDescription()
          Gets the description of this layout prototype.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getLayoutPrototypeId()
          Gets the layout prototype id of this layout prototype.
 String getName()
          Gets the name of this layout prototype.
 String getName(Locale locale)
          Gets the localized name of this layout prototype.
 String getName(Locale locale, boolean useDefault)
          Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.
 String getName(String languageId)
          Gets the localized name of this layout prototype.
 String getName(String languageId, boolean useDefault)
          Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.
 Map<Locale,String> getNameMap()
          Gets a map of the locales and localized name of this layout prototype.
 long getPrimaryKey()
          Gets the primary key of this layout prototype.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 String getSettings()
          Gets the settings of this layout prototype.
 int hashCode()
           
 boolean isActive()
          Determines whether this layout prototype is active.
 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 setActive(boolean active)
          Sets whether this {$entity.humanName} 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 layout prototype.
 void setDescription(String description)
          Sets the description of this layout prototype.
 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 setLayoutPrototypeId(long layoutPrototypeId)
          Sets the layout prototype id of this layout prototype.
 void setName(Locale locale, String name)
          Sets the localized name of this layout prototype.
 void setName(String name)
          Sets the name of this layout prototype.
 void setNameMap(Map<Locale,String> nameMap)
          Sets the localized names of this layout prototype from the map of locales and localized names.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(long pk)
          Sets the primary key of this layout prototype
 void setSettings(String settings)
          Sets the settings of this layout prototype.
 LayoutPrototype toEscapedModel()
          Gets a copy of this layout prototype 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 layout prototype.

Returns:
the primary key of this layout prototype

setPrimaryKey

void setPrimaryKey(long pk)
Sets the primary key of this layout prototype

Parameters:
pk - the primary key of this layout prototype

getLayoutPrototypeId

long getLayoutPrototypeId()
Gets the layout prototype id of this layout prototype.

Returns:
the layout prototype id of this layout prototype

setLayoutPrototypeId

void setLayoutPrototypeId(long layoutPrototypeId)
Sets the layout prototype id of this layout prototype.

Parameters:
layoutPrototypeId - the layout prototype id of this layout prototype

getCompanyId

long getCompanyId()
Gets the company id of this layout prototype.

Returns:
the company id of this layout prototype

setCompanyId

void setCompanyId(long companyId)
Sets the company id of this layout prototype.

Parameters:
companyId - the company id of this layout prototype

getName

String getName()
Gets the name of this layout prototype.

Returns:
the name of this layout prototype

getName

String getName(Locale locale)
Gets the localized name of this layout prototype. Uses the default language if no localization exists for the requested language.

Parameters:
locale - the locale to get the localized name for
Returns:
the localized name of this layout prototype

getName

String getName(Locale locale,
               boolean useDefault)
Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.

Parameters:
locale - the local to get the localized name for
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized name of this layout prototype. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

String getName(String languageId)
Gets the localized name of this layout prototype. Uses the default language if no localization exists for the requested language.

Parameters:
languageId - the id of the language to get the localized name for
Returns:
the localized name of this layout prototype

getName

String getName(String languageId,
               boolean useDefault)
Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.

Parameters:
languageId - the id of the language to get the localized name for
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized name of this layout prototype

getNameMap

Map<Locale,String> getNameMap()
Gets a map of the locales and localized name of this layout prototype.

Returns:
the locales and localized name

setName

void setName(String name)
Sets the name of this layout prototype.

Parameters:
name - the name of this layout prototype

setName

void setName(Locale locale,
             String name)
Sets the localized name of this layout prototype.

Parameters:
locale - the locale to set the localized name for
name - the localized name of this layout prototype

setNameMap

void setNameMap(Map<Locale,String> nameMap)
Sets the localized names of this layout prototype from the map of locales and localized names.

Parameters:
nameMap - the locales and localized names of this layout prototype

getDescription

@AutoEscape
String getDescription()
Gets the description of this layout prototype.

Returns:
the description of this layout prototype

setDescription

void setDescription(String description)
Sets the description of this layout prototype.

Parameters:
description - the description of this layout prototype

getSettings

@AutoEscape
String getSettings()
Gets the settings of this layout prototype.

Returns:
the settings of this layout prototype

setSettings

void setSettings(String settings)
Sets the settings of this layout prototype.

Parameters:
settings - the settings of this layout prototype

getActive

boolean getActive()
Gets the active of this layout prototype.

Returns:
the active of this layout prototype

isActive

boolean isActive()
Determines whether this layout prototype is active.

Returns:
whether this layout prototype is active

setActive

void setActive(boolean active)
Sets whether this {$entity.humanName} is active.

Parameters:
active - the active of this layout prototype

toEscapedModel

LayoutPrototype toEscapedModel()
Gets a copy of this layout prototype as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(LayoutPrototype layoutPrototype)
Specified by:
compareTo in interface Comparable<LayoutPrototype>

hashCode

int hashCode()
Overrides:
hashCode in class Object

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

Liferay 6.0.5