LayoutModel (Liferay 7.0-ga7 portal-kernel API)

All Superinterfaces:

AuditedModel, BaseModel<Layout>, ClassedModel, Cloneable, Comparable<Layout>, GroupedModel, LocalizedModel, MVCCModel, Serializable, ShardedModel, StagedGroupedModel, StagedModel

All Known Subinterfaces:

Layout

All Known Implementing Classes:

LayoutWrapper, VirtualLayout
```
@ProviderType
public interface LayoutModel
extends BaseModel<Layout>, LocalizedModel, MVCCModel, ShardedModel, StagedGroupedModel
```
The base model interface for the Layout service. Represents a row in the "Layout" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation LayoutModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in LayoutImpl.

Author:

Brian Wing Shun Chan

See Also:

Layout, LayoutImpl, LayoutModelImpl

{$generated.description}

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates a shallow clone of this model instance.
`int`	`compareTo(Layout layout)`
`String[]`	`getAvailableLanguageIds()`
`String`	`getColorSchemeId()` Returns the color scheme ID of this layout.
`long`	`getCompanyId()` Returns the company ID of this layout.
`Date`	`getCreateDate()` Returns the create date of this layout.
`String`	`getCss()` Returns the css of this layout.
`String`	`getDefaultLanguageId()`
`String`	`getDescription()` Returns the description of this layout.
`String`	`getDescription(Locale locale)` Returns the localized description of this layout in the language.
`String`	`getDescription(Locale locale, boolean useDefault)` Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
`String`	`getDescription(String languageId)` Returns the localized description of this layout in the language.
`String`	`getDescription(String languageId, boolean useDefault)` Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
`String`	`getDescriptionCurrentLanguageId()`
`String`	`getDescriptionCurrentValue()`
`Map<Locale,String>`	`getDescriptionMap()` Returns a map of the locales and localized descriptions of this layout.
`ExpandoBridge`	`getExpandoBridge()` Returns the expando bridge for this model instance.
`String`	`getFriendlyURL()` Returns the friendly url of this layout.
`long`	`getGroupId()` Returns the group ID of this layout.
`boolean`	`getHidden()` Returns the hidden of this layout.
`long`	`getIconImageId()` Returns the icon image ID of this layout.
`String`	`getKeywords()` Returns the keywords of this layout.
`String`	`getKeywords(Locale locale)` Returns the localized keywords of this layout in the language.
`String`	`getKeywords(Locale locale, boolean useDefault)` Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
`String`	`getKeywords(String languageId)` Returns the localized keywords of this layout in the language.
`String`	`getKeywords(String languageId, boolean useDefault)` Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
`String`	`getKeywordsCurrentLanguageId()`
`String`	`getKeywordsCurrentValue()`
`Map<Locale,String>`	`getKeywordsMap()` Returns a map of the locales and localized keywordses of this layout.
`Date`	`getLastPublishDate()` Returns the last publish date of this layout.
`long`	`getLayoutId()` Returns the layout ID of this layout.
`boolean`	`getLayoutPrototypeLinkEnabled()` Returns the layout prototype link enabled of this layout.
`String`	`getLayoutPrototypeUuid()` Returns the layout prototype uuid of this layout.
`Date`	`getModifiedDate()` Returns the modified date of this layout.
`long`	`getMvccVersion()` Returns the mvcc version of this layout.
`String`	`getName()` Returns the name of this layout.
`String`	`getName(Locale locale)` Returns the localized name of this layout in the language.
`String`	`getName(Locale locale, boolean useDefault)` Returns the localized name of this layout 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 in the language.
`String`	`getName(String languageId, boolean useDefault)` Returns the localized name of this layout 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.
`long`	`getParentLayoutId()` Returns the parent layout ID of this layout.
`long`	`getPlid()` Returns the plid of this layout.
`long`	`getPrimaryKey()` Returns the primary key of this layout.
`Serializable`	`getPrimaryKeyObj()` Returns the primary key of this model instance.
`int`	`getPriority()` Returns the priority of this layout.
`boolean`	`getPrivateLayout()` Returns the private layout of this layout.
`String`	`getRobots()` Returns the robots of this layout.
`String`	`getRobots(Locale locale)` Returns the localized robots of this layout in the language.
`String`	`getRobots(Locale locale, boolean useDefault)` Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
`String`	`getRobots(String languageId)` Returns the localized robots of this layout in the language.
`String`	`getRobots(String languageId, boolean useDefault)` Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
`String`	`getRobotsCurrentLanguageId()`
`String`	`getRobotsCurrentValue()`
`Map<Locale,String>`	`getRobotsMap()` Returns a map of the locales and localized robotses of this layout.
`String`	`getSourcePrototypeLayoutUuid()` Returns the source prototype layout uuid of this layout.
`String`	`getThemeId()` Returns the theme ID of this layout.
`String`	`getTitle()` Returns the title of this layout.
`String`	`getTitle(Locale locale)` Returns the localized title of this layout in the language.
`String`	`getTitle(Locale locale, boolean useDefault)` Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
`String`	`getTitle(String languageId)` Returns the localized title of this layout in the language.
`String`	`getTitle(String languageId, boolean useDefault)` Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
`String`	`getTitleCurrentLanguageId()`
`String`	`getTitleCurrentValue()`
`Map<Locale,String>`	`getTitleMap()` Returns a map of the locales and localized titles of this layout.
`String`	`getType()` Returns the type of this layout.
`String`	`getTypeSettings()` Returns the type settings of this layout.
`long`	`getUserId()` Returns the user ID of this layout.
`String`	`getUserName()` Returns the user name of this layout.
`String`	`getUserUuid()` Returns the user uuid of this layout.
`String`	`getUuid()` Returns the uuid of this layout.
`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`	`isHidden()` Returns `true` if this layout is hidden.
`boolean`	`isLayoutPrototypeLinkEnabled()` Returns `true` if this layout is layout prototype link enabled.
`boolean`	`isNew()` Returns `true` if this model instance does not yet exist in the database.
`boolean`	`isPrivateLayout()` Returns `true` if this layout is private layout.
`void`	`prepareLocalizedFieldsForImport()`
`void`	`prepareLocalizedFieldsForImport(Locale defaultImportLocale)`
`void`	`setCachedModel(boolean cachedModel)` Sets whether this model instance was retrieved from the entity cache.
`void`	`setColorSchemeId(String colorSchemeId)` Sets the color scheme ID of this layout.
`void`	`setCompanyId(long companyId)` Sets the company ID of this layout.
`void`	`setCreateDate(Date createDate)` Sets the create date of this layout.
`void`	`setCss(String css)` Sets the css of this layout.
`void`	`setDescription(String description)` Sets the description of this layout.
`void`	`setDescription(String description, Locale locale)` Sets the localized description of this layout in the language.
`void`	`setDescription(String description, Locale locale, Locale defaultLocale)` Sets the localized description of this layout in the language, and sets the default locale.
`void`	`setDescriptionCurrentLanguageId(String languageId)`
`void`	`setDescriptionMap(Map<Locale,String> descriptionMap)` Sets the localized descriptions of this layout from the map of locales and localized descriptions.
`void`	`setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)` Sets the localized descriptions of this layout from the map of locales and localized descriptions, and sets the default locale.
`void`	`setExpandoBridgeAttributes(BaseModel<?> baseModel)`
`void`	`setExpandoBridgeAttributes(ExpandoBridge expandoBridge)`
`void`	`setExpandoBridgeAttributes(ServiceContext serviceContext)` Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
`void`	`setFriendlyURL(String friendlyURL)` Sets the friendly url of this layout.
`void`	`setGroupId(long groupId)` Sets the group ID of this layout.
`void`	`setHidden(boolean hidden)` Sets whether this layout is hidden.
`void`	`setIconImageId(long iconImageId)` Sets the icon image ID of this layout.
`void`	`setKeywords(String keywords)` Sets the keywords of this layout.
`void`	`setKeywords(String keywords, Locale locale)` Sets the localized keywords of this layout in the language.
`void`	`setKeywords(String keywords, Locale locale, Locale defaultLocale)` Sets the localized keywords of this layout in the language, and sets the default locale.
`void`	`setKeywordsCurrentLanguageId(String languageId)`
`void`	`setKeywordsMap(Map<Locale,String> keywordsMap)` Sets the localized keywordses of this layout from the map of locales and localized keywordses.
`void`	`setKeywordsMap(Map<Locale,String> keywordsMap, Locale defaultLocale)` Sets the localized keywordses of this layout from the map of locales and localized keywordses, and sets the default locale.
`void`	`setLastPublishDate(Date lastPublishDate)` Sets the last publish date of this layout.
`void`	`setLayoutId(long layoutId)` Sets the layout ID of this layout.
`void`	`setLayoutPrototypeLinkEnabled(boolean layoutPrototypeLinkEnabled)` Sets whether this layout is layout prototype link enabled.
`void`	`setLayoutPrototypeUuid(String layoutPrototypeUuid)` Sets the layout prototype uuid of this layout.
`void`	`setModifiedDate(Date modifiedDate)` Sets the modified date of this layout.
`void`	`setMvccVersion(long mvccVersion)` Sets the mvcc version of this layout.
`void`	`setName(String name)` Sets the name of this layout.
`void`	`setName(String name, Locale locale)` Sets the localized name of this layout in the language.
`void`	`setName(String name, Locale locale, Locale defaultLocale)` Sets the localized name of this layout 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 from the map of locales and localized names.
`void`	`setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)` Sets the localized names of this layout 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`	`setParentLayoutId(long parentLayoutId)` Sets the parent layout ID of this layout.
`void`	`setPlid(long plid)` Sets the plid of this layout.
`void`	`setPrimaryKey(long primaryKey)` Sets the primary key of this layout.
`void`	`setPrimaryKeyObj(Serializable primaryKeyObj)` Sets the primary key of this model instance.
`void`	`setPriority(int priority)` Sets the priority of this layout.
`void`	`setPrivateLayout(boolean privateLayout)` Sets whether this layout is private layout.
`void`	`setRobots(String robots)` Sets the robots of this layout.
`void`	`setRobots(String robots, Locale locale)` Sets the localized robots of this layout in the language.
`void`	`setRobots(String robots, Locale locale, Locale defaultLocale)` Sets the localized robots of this layout in the language, and sets the default locale.
`void`	`setRobotsCurrentLanguageId(String languageId)`
`void`	`setRobotsMap(Map<Locale,String> robotsMap)` Sets the localized robotses of this layout from the map of locales and localized robotses.
`void`	`setRobotsMap(Map<Locale,String> robotsMap, Locale defaultLocale)` Sets the localized robotses of this layout from the map of locales and localized robotses, and sets the default locale.
`void`	`setSourcePrototypeLayoutUuid(String sourcePrototypeLayoutUuid)` Sets the source prototype layout uuid of this layout.
`void`	`setThemeId(String themeId)` Sets the theme ID of this layout.
`void`	`setTitle(String title)` Sets the title of this layout.
`void`	`setTitle(String title, Locale locale)` Sets the localized title of this layout in the language.
`void`	`setTitle(String title, Locale locale, Locale defaultLocale)` Sets the localized title of this layout in the language, and sets the default locale.
`void`	`setTitleCurrentLanguageId(String languageId)`
`void`	`setTitleMap(Map<Locale,String> titleMap)` Sets the localized titles of this layout from the map of locales and localized titles.
`void`	`setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)` Sets the localized titles of this layout from the map of locales and localized titles, and sets the default locale.
`void`	`setType(String type)` Sets the type of this layout.
`void`	`setTypeSettings(String typeSettings)` Sets the type settings of this layout.
`void`	`setUserId(long userId)` Sets the user ID of this layout.
`void`	`setUserName(String userName)` Sets the user name of this layout.
`void`	`setUserUuid(String userUuid)` Sets the user uuid of this layout.
`void`	`setUuid(String uuid)` Sets the uuid of this layout.
`CacheModel<Layout>`	`toCacheModel()` Returns a cache model object for this entity used by entity cache.
`Layout`	`toEscapedModel()` Returns a copy of this entity as an escaped model instance by wrapping it with an `AutoEscapeBeanHandler`.
`String`	`toString()`
`Layout`	`toUnescapedModel()`
`String`	`toXmlString()` Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
getStagedModelType

- Method Detail
  - getPrimaryKey
```
long getPrimaryKey()
```
    Returns the primary key of this layout.
    
    Returns:
    
    the primary key of this layout
  - setPrimaryKey
```
void setPrimaryKey(long primaryKey)
```
    Sets the primary key of this layout.
    
    Parameters:
    
    primaryKey - the primary key of this layout
  - getMvccVersion
```
long getMvccVersion()
```
    Returns the mvcc version of this layout.
    
    Specified by:
    
    getMvccVersion in interface MVCCModel
    
    Returns:
    
    the mvcc version of this layout
  - setMvccVersion
```
void setMvccVersion(long mvccVersion)
```
    Sets the mvcc version of this layout.
    
    Specified by:
    
    setMvccVersion in interface MVCCModel
    
    Parameters:
    
    mvccVersion - the mvcc version of this layout
  - getUuid
```
@AutoEscape
String getUuid()
```
    Returns the uuid of this layout.
    
    Specified by:
    
    getUuid in interface StagedModel
    
    Returns:
    
    the uuid of this layout
  - setUuid
```
void setUuid(String uuid)
```
    Sets the uuid of this layout.
    
    Specified by:
    
    setUuid in interface StagedModel
    
    Parameters:
    
    uuid - the uuid of this layout
  - getPlid
```
long getPlid()
```
    Returns the plid of this layout.
    
    Returns:
    
    the plid of this layout
  - setPlid
```
void setPlid(long plid)
```
    Sets the plid of this layout.
    
    Parameters:
    
    plid - the plid of this layout
  - getGroupId
```
long getGroupId()
```
    Returns the group ID of this layout.
    
    Specified by:
    
    getGroupId in interface GroupedModel
    
    Returns:
    
    the group ID of this layout
  - setGroupId
```
void setGroupId(long groupId)
```
    Sets the group ID of this layout.
    
    Specified by:
    
    setGroupId in interface GroupedModel
    
    Parameters:
    
    groupId - the group ID of this layout
  - getCompanyId
```
long getCompanyId()
```
    Returns the company ID of this layout.
    
    Specified by:
    
    getCompanyId in interface AuditedModel
    
    Specified by:
    
    getCompanyId in interface ShardedModel
    
    Specified by:
    
    getCompanyId in interface StagedModel
    
    Returns:
    
    the company ID of this layout
  - setCompanyId
```
void setCompanyId(long companyId)
```
    Sets the company ID of this layout.
    
    Specified by:
    
    setCompanyId in interface AuditedModel
    
    Specified by:
    
    setCompanyId in interface ShardedModel
    
    Specified by:
    
    setCompanyId in interface StagedModel
    
    Parameters:
    
    companyId - the company ID of this layout
  - getUserId
```
long getUserId()
```
    Returns the user ID of this layout.
    
    Specified by:
    
    getUserId in interface AuditedModel
    
    Returns:
    
    the user ID of this layout
  - setUserId
```
void setUserId(long userId)
```
    Sets the user ID of this layout.
    
    Specified by:
    
    setUserId in interface AuditedModel
    
    Parameters:
    
    userId - the user ID of this layout
  - getUserUuid
```
String getUserUuid()
```
    Returns the user uuid of this layout.
    
    Specified by:
    
    getUserUuid in interface AuditedModel
    
    Returns:
    
    the user uuid of this layout
  - setUserUuid
```
void setUserUuid(String userUuid)
```
    Sets the user uuid of this layout.
    
    Specified by:
    
    setUserUuid in interface AuditedModel
    
    Parameters:
    
    userUuid - the user uuid of this layout
  - getUserName
```
@AutoEscape
String getUserName()
```
    Returns the user name of this layout.
    
    Specified by:
    
    getUserName in interface AuditedModel
    
    Returns:
    
    the user name of this layout
  - setUserName
```
void setUserName(String userName)
```
    Sets the user name of this layout.
    
    Specified by:
    
    setUserName in interface AuditedModel
    
    Parameters:
    
    userName - the user name of this layout
  - getCreateDate
```
Date getCreateDate()
```
    Returns the create date of this layout.
    
    Specified by:
    
    getCreateDate in interface AuditedModel
    
    Specified by:
    
    getCreateDate in interface StagedModel
    
    Returns:
    
    the create date of this layout
  - setCreateDate
```
void setCreateDate(Date createDate)
```
    Sets the create date of this layout.
    
    Specified by:
    
    setCreateDate in interface AuditedModel
    
    Specified by:
    
    setCreateDate in interface StagedModel
    
    Parameters:
    
    createDate - the create date of this layout
  - getModifiedDate
```
Date getModifiedDate()
```
    Returns the modified date of this layout.
    
    Specified by:
    
    getModifiedDate in interface AuditedModel
    
    Specified by:
    
    getModifiedDate in interface StagedModel
    
    Returns:
    
    the modified date of this layout
  - setModifiedDate
```
void setModifiedDate(Date modifiedDate)
```
    Sets the modified date of this layout.
    
    Specified by:
    
    setModifiedDate in interface AuditedModel
    
    Specified by:
    
    setModifiedDate in interface StagedModel
    
    Parameters:
    
    modifiedDate - the modified date of this layout
  - getPrivateLayout
```
boolean getPrivateLayout()
```
    Returns the private layout of this layout.
    
    Returns:
    
    the private layout of this layout
  - isPrivateLayout
```
boolean isPrivateLayout()
```
    Returns true if this layout is private layout.
    
    Returns:
    
    true if this layout is private layout; false otherwise
  - setPrivateLayout
```
void setPrivateLayout(boolean privateLayout)
```
    Sets whether this layout is private layout.
    
    Parameters:
    
    privateLayout - the private layout of this layout
  - getLayoutId
```
long getLayoutId()
```
    Returns the layout ID of this layout.
    
    Returns:
    
    the layout ID of this layout
  - setLayoutId
```
void setLayoutId(long layoutId)
```
    Sets the layout ID of this layout.
    
    Parameters:
    
    layoutId - the layout ID of this layout
  - getParentLayoutId
```
long getParentLayoutId()
```
    Returns the parent layout ID of this layout.
    
    Returns:
    
    the parent layout ID of this layout
  - setParentLayoutId
```
void setParentLayoutId(long parentLayoutId)
```
    Sets the parent layout ID of this layout.
    
    Parameters:
    
    parentLayoutId - the parent layout ID of this layout
  - getName
```
String getName()
```
    Returns the name of this layout.
    
    Returns:
    
    the name of this layout
  - getName
```
@AutoEscape
String getName(Locale locale)
```
    Returns the localized name of this layout 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
  - getName
```
@AutoEscape
String getName(Locale locale,
                           boolean useDefault)
```
    Returns the localized name of this layout 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. 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 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
  - getName
```
@AutoEscape
String getName(String languageId,
                           boolean useDefault)
```
    Returns the localized name of this layout 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
  - 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.
    
    Returns:
    
    the locales and localized names of this layout
  - setName
```
void setName(String name)
```
    Sets the name of this layout.
    
    Parameters:
    
    name - the name of this layout
  - setName
```
void setName(String name,
             Locale locale)
```
    Sets the localized name of this layout in the language.
    
    Parameters:
    
    name - the localized name of this layout
    
    locale - the locale of the language
  - setName
```
void setName(String name,
             Locale locale,
             Locale defaultLocale)
```
    Sets the localized name of this layout in the language, and sets the default locale.
    
    Parameters:
    
    name - the localized name of this layout
    
    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 from the map of locales and localized names.
    
    Parameters:
    
    nameMap - the locales and localized names of this layout
  - setNameMap
```
void setNameMap(Map<Locale,String> nameMap,
                Locale defaultLocale)
```
    Sets the localized names of this layout from the map of locales and localized names, and sets the default locale.
    
    Parameters:
    
    nameMap - the locales and localized names of this layout
    
    defaultLocale - the default locale
  - getTitle
```
String getTitle()
```
    Returns the title of this layout.
    
    Returns:
    
    the title of this layout
  - getTitle
```
@AutoEscape
String getTitle(Locale locale)
```
    Returns the localized title of this layout 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 title of this layout
  - getTitle
```
@AutoEscape
String getTitle(Locale locale,
                            boolean useDefault)
```
    Returns the localized title of this layout 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 title of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
  - getTitle
```
@AutoEscape
String getTitle(String languageId)
```
    Returns the localized title of this layout 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 title of this layout
  - getTitle
```
@AutoEscape
String getTitle(String languageId,
                            boolean useDefault)
```
    Returns the localized title of this layout 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 title of this layout
  - getTitleCurrentLanguageId
```
@AutoEscape
String getTitleCurrentLanguageId()
```
  - getTitleCurrentValue
```
@AutoEscape
String getTitleCurrentValue()
```
  - getTitleMap
```
Map<Locale,String> getTitleMap()
```
    Returns a map of the locales and localized titles of this layout.
    
    Returns:
    
    the locales and localized titles of this layout
  - setTitle
```
void setTitle(String title)
```
    Sets the title of this layout.
    
    Parameters:
    
    title - the title of this layout
  - setTitle
```
void setTitle(String title,
              Locale locale)
```
    Sets the localized title of this layout in the language.
    
    Parameters:
    
    title - the localized title of this layout
    
    locale - the locale of the language
  - setTitle
```
void setTitle(String title,
              Locale locale,
              Locale defaultLocale)
```
    Sets the localized title of this layout in the language, and sets the default locale.
    
    Parameters:
    
    title - the localized title of this layout
    
    locale - the locale of the language
    
    defaultLocale - the default locale
  - setTitleCurrentLanguageId
```
void setTitleCurrentLanguageId(String languageId)
```
  - setTitleMap
```
void setTitleMap(Map<Locale,String> titleMap)
```
    Sets the localized titles of this layout from the map of locales and localized titles.
    
    Parameters:
    
    titleMap - the locales and localized titles of this layout
  - setTitleMap
```
void setTitleMap(Map<Locale,String> titleMap,
                 Locale defaultLocale)
```
    Sets the localized titles of this layout from the map of locales and localized titles, and sets the default locale.
    
    Parameters:
    
    titleMap - the locales and localized titles of this layout
    
    defaultLocale - the default locale
  - getDescription
```
String getDescription()
```
    Returns the description of this layout.
    
    Returns:
    
    the description of this layout
  - getDescription
```
@AutoEscape
String getDescription(Locale locale)
```
    Returns the localized description of this layout 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 description of this layout
  - getDescription
```
@AutoEscape
String getDescription(Locale locale,
                                  boolean useDefault)
```
    Returns the localized description of this layout 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 description of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
  - getDescription
```
@AutoEscape
String getDescription(String languageId)
```
    Returns the localized description of this layout 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 description of this layout
  - getDescription
```
@AutoEscape
String getDescription(String languageId,
                                  boolean useDefault)
```
    Returns the localized description of this layout 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 description of this layout
  - getDescriptionCurrentLanguageId
```
@AutoEscape
String getDescriptionCurrentLanguageId()
```
  - getDescriptionCurrentValue
```
@AutoEscape
String getDescriptionCurrentValue()
```
  - getDescriptionMap
```
Map<Locale,String> getDescriptionMap()
```
    Returns a map of the locales and localized descriptions of this layout.
    
    Returns:
    
    the locales and localized descriptions of this layout
  - setDescription
```
void setDescription(String description)
```
    Sets the description of this layout.
    
    Parameters:
    
    description - the description of this layout
  - setDescription
```
void setDescription(String description,
                    Locale locale)
```
    Sets the localized description of this layout in the language.
    
    Parameters:
    
    description - the localized description of this layout
    
    locale - the locale of the language
  - setDescription
```
void setDescription(String description,
                    Locale locale,
                    Locale defaultLocale)
```
    Sets the localized description of this layout in the language, and sets the default locale.
    
    Parameters:
    
    description - the localized description of this layout
    
    locale - the locale of the language
    
    defaultLocale - the default locale
  - setDescriptionCurrentLanguageId
```
void setDescriptionCurrentLanguageId(String languageId)
```
  - setDescriptionMap
```
void setDescriptionMap(Map<Locale,String> descriptionMap)
```
    Sets the localized descriptions of this layout from the map of locales and localized descriptions.
    
    Parameters:
    
    descriptionMap - the locales and localized descriptions of this layout
  - setDescriptionMap
```
void setDescriptionMap(Map<Locale,String> descriptionMap,
                       Locale defaultLocale)
```
    Sets the localized descriptions of this layout from the map of locales and localized descriptions, and sets the default locale.
    
    Parameters:
    
    descriptionMap - the locales and localized descriptions of this layout
    
    defaultLocale - the default locale
  - getKeywords
```
String getKeywords()
```
    Returns the keywords of this layout.
    
    Returns:
    
    the keywords of this layout
  - getKeywords
```
@AutoEscape
String getKeywords(Locale locale)
```
    Returns the localized keywords of this layout 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 keywords of this layout
  - getKeywords
```
@AutoEscape
String getKeywords(Locale locale,
                               boolean useDefault)
```
    Returns the localized keywords of this layout 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 keywords of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
  - getKeywords
```
@AutoEscape
String getKeywords(String languageId)
```
    Returns the localized keywords of this layout 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 keywords of this layout
  - getKeywords
```
@AutoEscape
String getKeywords(String languageId,
                               boolean useDefault)
```
    Returns the localized keywords of this layout 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 keywords of this layout
  - getKeywordsCurrentLanguageId
```
@AutoEscape
String getKeywordsCurrentLanguageId()
```
  - getKeywordsCurrentValue
```
@AutoEscape
String getKeywordsCurrentValue()
```
  - getKeywordsMap
```
Map<Locale,String> getKeywordsMap()
```
    Returns a map of the locales and localized keywordses of this layout.
    
    Returns:
    
    the locales and localized keywordses of this layout
  - setKeywords
```
void setKeywords(String keywords)
```
    Sets the keywords of this layout.
    
    Parameters:
    
    keywords - the keywords of this layout
  - setKeywords
```
void setKeywords(String keywords,
                 Locale locale)
```
    Sets the localized keywords of this layout in the language.
    
    Parameters:
    
    keywords - the localized keywords of this layout
    
    locale - the locale of the language
  - setKeywords
```
void setKeywords(String keywords,
                 Locale locale,
                 Locale defaultLocale)
```
    Sets the localized keywords of this layout in the language, and sets the default locale.
    
    Parameters:
    
    keywords - the localized keywords of this layout
    
    locale - the locale of the language
    
    defaultLocale - the default locale
  - setKeywordsCurrentLanguageId
```
void setKeywordsCurrentLanguageId(String languageId)
```
  - setKeywordsMap
```
void setKeywordsMap(Map<Locale,String> keywordsMap)
```
    Sets the localized keywordses of this layout from the map of locales and localized keywordses.
    
    Parameters:
    
    keywordsMap - the locales and localized keywordses of this layout
  - setKeywordsMap
```
void setKeywordsMap(Map<Locale,String> keywordsMap,
                    Locale defaultLocale)
```
    Sets the localized keywordses of this layout from the map of locales and localized keywordses, and sets the default locale.
    
    Parameters:
    
    keywordsMap - the locales and localized keywordses of this layout
    
    defaultLocale - the default locale
  - getRobots
```
String getRobots()
```
    Returns the robots of this layout.
    
    Returns:
    
    the robots of this layout
  - getRobots
```
@AutoEscape
String getRobots(Locale locale)
```
    Returns the localized robots of this layout 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 robots of this layout
  - getRobots
```
@AutoEscape
String getRobots(Locale locale,
                             boolean useDefault)
```
    Returns the localized robots of this layout 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 robots of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
  - getRobots
```
@AutoEscape
String getRobots(String languageId)
```
    Returns the localized robots of this layout 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 robots of this layout
  - getRobots
```
@AutoEscape
String getRobots(String languageId,
                             boolean useDefault)
```
    Returns the localized robots of this layout 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 robots of this layout
  - getRobotsCurrentLanguageId
```
@AutoEscape
String getRobotsCurrentLanguageId()
```
  - getRobotsCurrentValue
```
@AutoEscape
String getRobotsCurrentValue()
```
  - getRobotsMap
```
Map<Locale,String> getRobotsMap()
```
    Returns a map of the locales and localized robotses of this layout.
    
    Returns:
    
    the locales and localized robotses of this layout
  - setRobots
```
void setRobots(String robots)
```
    Sets the robots of this layout.
    
    Parameters:
    
    robots - the robots of this layout
  - setRobots
```
void setRobots(String robots,
               Locale locale)
```
    Sets the localized robots of this layout in the language.
    
    Parameters:
    
    robots - the localized robots of this layout
    
    locale - the locale of the language
  - setRobots
```
void setRobots(String robots,
               Locale locale,
               Locale defaultLocale)
```
    Sets the localized robots of this layout in the language, and sets the default locale.
    
    Parameters:
    
    robots - the localized robots of this layout
    
    locale - the locale of the language
    
    defaultLocale - the default locale
  - setRobotsCurrentLanguageId
```
void setRobotsCurrentLanguageId(String languageId)
```
  - setRobotsMap
```
void setRobotsMap(Map<Locale,String> robotsMap)
```
    Sets the localized robotses of this layout from the map of locales and localized robotses.
    
    Parameters:
    
    robotsMap - the locales and localized robotses of this layout
  - setRobotsMap
```
void setRobotsMap(Map<Locale,String> robotsMap,
                  Locale defaultLocale)
```
    Sets the localized robotses of this layout from the map of locales and localized robotses, and sets the default locale.
    
    Parameters:
    
    robotsMap - the locales and localized robotses of this layout
    
    defaultLocale - the default locale
  - getType
```
@AutoEscape
String getType()
```
    Returns the type of this layout.
    
    Returns:
    
    the type of this layout
  - setType
```
void setType(String type)
```
    Sets the type of this layout.
    
    Parameters:
    
    type - the type of this layout
  - getTypeSettings
```
@AutoEscape
String getTypeSettings()
```
    Returns the type settings of this layout.
    
    Returns:
    
    the type settings of this layout
  - setTypeSettings
```
void setTypeSettings(String typeSettings)
```
    Sets the type settings of this layout.
    
    Parameters:
    
    typeSettings - the type settings of this layout
  - getHidden
```
boolean getHidden()
```
    Returns the hidden of this layout.
    
    Returns:
    
    the hidden of this layout
  - isHidden
```
boolean isHidden()
```
    Returns true if this layout is hidden.
    
    Returns:
    
    true if this layout is hidden; false otherwise
  - setHidden
```
void setHidden(boolean hidden)
```
    Sets whether this layout is hidden.
    
    Parameters:
    
    hidden - the hidden of this layout
  - getFriendlyURL
```
@AutoEscape
String getFriendlyURL()
```
    Returns the friendly url of this layout.
    
    Returns:
    
    the friendly url of this layout
  - setFriendlyURL
```
void setFriendlyURL(String friendlyURL)
```
    Sets the friendly url of this layout.
    
    Parameters:
    
    friendlyURL - the friendly url of this layout
  - getIconImageId
```
long getIconImageId()
```
    Returns the icon image ID of this layout.
    
    Returns:
    
    the icon image ID of this layout
  - setIconImageId
```
void setIconImageId(long iconImageId)
```
    Sets the icon image ID of this layout.
    
    Parameters:
    
    iconImageId - the icon image ID of this layout
  - getThemeId
```
@AutoEscape
String getThemeId()
```
    Returns the theme ID of this layout.
    
    Returns:
    
    the theme ID of this layout
  - setThemeId
```
void setThemeId(String themeId)
```
    Sets the theme ID of this layout.
    
    Parameters:
    
    themeId - the theme ID of this layout
  - getColorSchemeId
```
@AutoEscape
String getColorSchemeId()
```
    Returns the color scheme ID of this layout.
    
    Returns:
    
    the color scheme ID of this layout
  - setColorSchemeId
```
void setColorSchemeId(String colorSchemeId)
```
    Sets the color scheme ID of this layout.
    
    Parameters:
    
    colorSchemeId - the color scheme ID of this layout
  - getCss
```
@AutoEscape
String getCss()
```
    Returns the css of this layout.
    
    Returns:
    
    the css of this layout
  - setCss
```
void setCss(String css)
```
    Sets the css of this layout.
    
    Parameters:
    
    css - the css of this layout
  - getPriority
```
int getPriority()
```
    Returns the priority of this layout.
    
    Returns:
    
    the priority of this layout
  - setPriority
```
void setPriority(int priority)
```
    Sets the priority of this layout.
    
    Parameters:
    
    priority - the priority of this layout
  - getLayoutPrototypeUuid
```
@AutoEscape
String getLayoutPrototypeUuid()
```
    Returns the layout prototype uuid of this layout.
    
    Returns:
    
    the layout prototype uuid of this layout
  - setLayoutPrototypeUuid
```
void setLayoutPrototypeUuid(String layoutPrototypeUuid)
```
    Sets the layout prototype uuid of this layout.
    
    Parameters:
    
    layoutPrototypeUuid - the layout prototype uuid of this layout
  - getLayoutPrototypeLinkEnabled
```
boolean getLayoutPrototypeLinkEnabled()
```
    Returns the layout prototype link enabled of this layout.
    
    Returns:
    
    the layout prototype link enabled of this layout
  - isLayoutPrototypeLinkEnabled
```
boolean isLayoutPrototypeLinkEnabled()
```
    Returns true if this layout is layout prototype link enabled.
    
    Returns:
    
    true if this layout is layout prototype link enabled; false otherwise
  - setLayoutPrototypeLinkEnabled
```
void setLayoutPrototypeLinkEnabled(boolean layoutPrototypeLinkEnabled)
```
    Sets whether this layout is layout prototype link enabled.
    
    Parameters:
    
    layoutPrototypeLinkEnabled - the layout prototype link enabled of this layout
  - getSourcePrototypeLayoutUuid
```
@AutoEscape
String getSourcePrototypeLayoutUuid()
```
    Returns the source prototype layout uuid of this layout.
    
    Returns:
    
    the source prototype layout uuid of this layout
  - setSourcePrototypeLayoutUuid
```
void setSourcePrototypeLayoutUuid(String sourcePrototypeLayoutUuid)
```
    Sets the source prototype layout uuid of this layout.
    
    Parameters:
    
    sourcePrototypeLayoutUuid - the source prototype layout uuid of this layout
  - getLastPublishDate
```
Date getLastPublishDate()
```
    Returns the last publish date of this layout.
    
    Specified by:
    
    getLastPublishDate in interface StagedGroupedModel
    
    Returns:
    
    the last publish date of this layout
  - setLastPublishDate
```
void setLastPublishDate(Date lastPublishDate)
```
    Sets the last publish date of this layout.
    
    Specified by:
    
    setLastPublishDate in interface StagedGroupedModel
    
    Parameters:
    
    lastPublishDate - the last publish date of this layout
  - 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<Layout>
    
    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<Layout>
    
    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<Layout>
    
    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<Layout>
    
    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<Layout>
    
    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<Layout>
    
    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<Layout>
    
    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<Layout>
    
    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<Layout>
  - setExpandoBridgeAttributes
```
void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
```
    Specified by:
    
    setExpandoBridgeAttributes in interface BaseModel<Layout>
  - 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<Layout>
    
    Parameters:
    
    serviceContext - the service context to be applied
    
    See Also:
    
    ServiceContext.getExpandoBridgeAttributes()
  - getAvailableLanguageIds
```
String[] getAvailableLanguageIds()
```
    Specified by:
    
    getAvailableLanguageIds in interface LocalizedModel
  - getDefaultLanguageId
```
String getDefaultLanguageId()
```
    Specified by:
    
    getDefaultLanguageId in interface LocalizedModel
  - prepareLocalizedFieldsForImport
```
void prepareLocalizedFieldsForImport()
                              throws LocaleException
```
    Specified by:
    
    prepareLocalizedFieldsForImport in interface LocalizedModel
    
    Throws:
    
    LocaleException
  - prepareLocalizedFieldsForImport
```
void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                              throws LocaleException
```
    Specified by:
    
    prepareLocalizedFieldsForImport in interface LocalizedModel
    
    Throws:
    
    LocaleException
  - clone
```
Object clone()
```
    Description copied from interface: BaseModel
    
    Creates a shallow clone of this model instance.
    
    Specified by:
    
    clone in interface BaseModel<Layout>
    
    Specified by:
    
    clone in interface StagedModel
    
    Returns:
    
    the shallow clone of this model instance
  - compareTo
```
int compareTo(Layout layout)
```
    Specified by:
    
    compareTo in interface Comparable<Layout>
  - hashCode
```
int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toCacheModel
```
CacheModel<Layout> toCacheModel()
```
    Description copied from interface: BaseModel
    
    Returns a cache model object for this entity used by entity cache.
    
    Specified by:
    
    toCacheModel in interface BaseModel<Layout>
    
    Returns:
    
    the cache model object
  - toEscapedModel
```
Layout 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<Layout>
    
    Returns:
    
    the escaped model instance
    
    See Also:
    
    AutoEscapeBeanHandler
  - toUnescapedModel
```
Layout toUnescapedModel()
```
    Specified by:
    
    toUnescapedModel in interface BaseModel<Layout>
  - 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<Layout>
    
    Returns:
    
    the XML representation of this model instance

Interface LayoutModel

Method Summary

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

Method Detail

getPrimaryKey

setPrimaryKey

getMvccVersion

setMvccVersion

getUuid

setUuid

getPlid

setPlid

getGroupId

setGroupId

getCompanyId

setCompanyId

getUserId

setUserId

getUserUuid

setUserUuid

getUserName

setUserName

getCreateDate

setCreateDate

getModifiedDate

setModifiedDate

getPrivateLayout

isPrivateLayout

setPrivateLayout

getLayoutId

setLayoutId

getParentLayoutId

setParentLayoutId

getName

getName

getName

getName

getName

getNameCurrentLanguageId

getNameCurrentValue

getNameMap

setName

setName

setName

setNameCurrentLanguageId

setNameMap

setNameMap

getTitle

getTitle

getTitle

getTitle

getTitle

getTitleCurrentLanguageId

getTitleCurrentValue

getTitleMap

setTitle

setTitle

setTitle

setTitleCurrentLanguageId

setTitleMap

setTitleMap

getDescription

getDescription

getDescription

getDescription

getDescription

getDescriptionCurrentLanguageId

getDescriptionCurrentValue

getDescriptionMap

setDescription

setDescription

setDescription

setDescriptionCurrentLanguageId

setDescriptionMap

setDescriptionMap

getKeywords

getKeywords

getKeywords