Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface LayoutPrototypeModel

All Superinterfaces:
BaseModel<LayoutPrototype>, ClassedModel, Cloneable, Comparable<LayoutPrototype>, Serializable
All Known Subinterfaces:
LayoutPrototype
All Known Implementing Classes:
LayoutPrototypeBaseImpl, 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.

See Also:
LayoutPrototype, LayoutPrototypeImpl, LayoutPrototypeModelImpl
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(LayoutPrototype layoutPrototype)
           
 boolean getActive()
          Returns the active of this layout prototype.
 long getCompanyId()
          Returns the company ID of this layout prototype.
 String getDescription()
          Returns the description of this layout prototype.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getLayoutPrototypeId()
          Returns the layout prototype ID of this layout prototype.
 String getName()
          Returns the name of this layout prototype.
 String getName(Locale locale)
          Returns the localized name of this layout prototype in the language.
 String getName(Locale locale, boolean useDefault)
          Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.
 String getName(String languageId)
          Returns the localized name of this layout prototype in the language.
 String getName(String languageId, boolean useDefault)
          Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.
 String getNameCurrentLanguageId()
           
 String getNameCurrentValue()
           
 Map<Locale,String> getNameMap()
          Returns a map of the locales and localized names of this layout prototype.
 long getPrimaryKey()
          Returns the primary key of this layout prototype.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 String getSettings()
          Returns the settings of this layout prototype.
 String getUuid()
          Returns the uuid of this layout prototype.
 int hashCode()
           
 boolean isActive()
          Returns true if this layout prototype 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 prepareLocalizedFieldsForImport(Locale defaultImportLocale)
           
 void setActive(boolean active)
          Sets whether this layout prototype 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 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(String name)
          Sets the name of this layout prototype.
 void setName(String name, Locale locale)
          Sets the localized name of this layout prototype in the language.
 void setName(String name, Locale locale, Locale defaultLocale)
          Sets the localized name of this layout prototype in the language, and sets the default locale.
 void setNameCurrentLanguageId(String languageId)
           
 void setNameMap(Map<Locale,String> nameMap)
          Sets the localized names of this layout prototype from the map of locales and localized names.
 void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
          Sets the localized names of this layout prototype from the map of locales and localized names, and sets the default locale.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this layout prototype.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setSettings(String settings)
          Sets the settings of this layout prototype.
 void setUuid(String uuid)
          Sets the uuid of this layout prototype.
 CacheModel<LayoutPrototype> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 LayoutPrototype toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 LayoutPrototype 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 layout prototype.

Returns:
the primary key of this layout prototype

setPrimaryKey

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

Parameters:
primaryKey - the primary key of this layout prototype

getUuid

@AutoEscape
String getUuid()
Returns the uuid of this layout prototype.

Returns:
the uuid of this layout prototype

setUuid

void setUuid(String uuid)
Sets the uuid of this layout prototype.

Parameters:
uuid - the uuid of this layout prototype

getLayoutPrototypeId

long getLayoutPrototypeId()
Returns 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()
Returns 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()
Returns the name of this layout prototype.

Returns:
the name of this layout prototype

getName

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

Parameters:
locale - the locale of the language
Returns:
the localized name of this layout prototype

getName

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

Parameters:
locale - the local of the language
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

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

Parameters:
languageId - the ID of the language
Returns:
the localized name of this layout prototype

getName

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

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

getNameCurrentLanguageId

@AutoEscape
String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
String getNameCurrentValue()

getNameMap

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

Returns:
the locales and localized names of this layout prototype

setName

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

Parameters:
name - the name of this layout prototype

setName

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

Parameters:
name - the localized name of this layout prototype
locale - the locale of the language

setName

void setName(String name,
             Locale locale,
             Locale defaultLocale)
Sets the localized name of this layout prototype in the language, and sets the default locale.

Parameters:
name - the localized name of this layout prototype
locale - the locale of the language
defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(String languageId)

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

setNameMap

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

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

getDescription

@AutoEscape
String getDescription()
Returns 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()
Returns 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()
Returns the active of this layout prototype.

Returns:
the active of this layout prototype

isActive

boolean isActive()
Returns true if this layout prototype is active.

Returns:
true if this layout prototype is active; false otherwise

setActive

void setActive(boolean active)
Sets whether this layout prototype is active.

Parameters:
active - the active of this layout prototype

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<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
Returns true 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
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
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<LayoutPrototype>
Parameters:
serviceContext - the service context
See Also:
ServiceContext.getExpandoBridgeAttributes( )

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException
Throws:
LocaleException

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

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

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

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

Liferay 6.1.2-ce-ga3