Package com.liferay.portal.kernel.model
Interface LayoutModel
- All Superinterfaces:
AttachedModel,AuditedModel,BaseModel<Layout>,ClassedModel,Cloneable,Comparable<Layout>,CTModel<Layout>,ExternalReferenceCodeModel,GroupedModel,LocalizedModel,MVCCModel,Serializable,ShardedModel,StagedGroupedModel,StagedModel,TypedModel,WorkflowedModel
- All Known Subinterfaces:
Layout
- All Known Implementing Classes:
LayoutWrapper,VirtualLayout
@ProviderType
public interface LayoutModel
extends AttachedModel, BaseModel<Layout>, CTModel<Layout>, ExternalReferenceCodeModel, LocalizedModel, MVCCModel, ShardedModel, StagedGroupedModel, WorkflowedModel
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 com.liferay.portal.model.impl.LayoutModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portal.model.impl.LayoutImpl.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionString[]Returns the fully qualified class name of this layout.longReturns the class name ID of this layout.longReturns the class pk of this layout.Returns the color scheme ID of this layout.longReturns the company ID of this layout.Returns the create date of this layout.getCss()Returns the css of this layout.longReturns the ct collection ID of this layout.Returns the description of this layout.getDescription(String languageId) Returns the localized description of this layout in the language.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.getDescription(Locale locale) Returns the localized description of this layout in the language.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.Returns a map of the locales and localized descriptions of this layout.Returns the external reference code of this layout.longReturns the favicon file entry ID of this layout.Returns the friendly url of this layout.longReturns the group ID of this layout.booleanReturns the hidden of this layout.longReturns the icon image ID of this layout.Returns the keywords of this layout.getKeywords(String languageId) Returns the localized keywords of this layout in the language.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.getKeywords(Locale locale) Returns the localized keywords of this layout in the language.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.Returns a map of the locales and localized keywordses of this layout.Returns the last publish date of this layout.longReturns the layout ID of this layout.booleanReturns the layout prototype link enabled of this layout.Returns the layout prototype uuid of this layout.longReturns the master layout plid of this layout.Returns the modified date of this layout.longReturns the mvcc version of this layout.getName()Returns the name of this layout.Returns the localized name of this layout in the language.Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this layout in the language.Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized names of this layout.longReturns the parent layout ID of this layout.longReturns the parent plid of this layout.longgetPlid()Returns the plid of this layout.longReturns the primary key of this layout.intReturns the priority of this layout.booleanReturns the private layout of this layout.Returns the publish date of this layout.Returns the robots of this layout.Returns the localized robots of this layout in the language.Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.Returns the localized robots of this layout in the language.Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized robotses of this layout.Returns the source prototype layout uuid of this layout.intReturns the status of this layout.longReturns the status by user ID of this layout.Returns the status by user name of this layout.Returns the status by user uuid of this layout.Returns the status date of this layout.longReturns the style book entry ID of this layout.booleanReturns the system of this layout.Returns the theme ID of this layout.getTitle()Returns the title of this layout.Returns the localized title of this layout in the language.Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.Returns the localized title of this layout in the language.Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized titles of this layout.getType()Returns the type of this layout.Returns the type settings of this layout.longReturns the user ID of this layout.Returns the user name of this layout.Returns the user uuid of this layout.getUuid()Returns the uuid of this layout.booleanReturnstrueif this layout is approved.booleanisDenied()Returnstrueif this layout is denied.booleanisDraft()Returnstrueif this layout is a draft.booleanReturnstrueif this layout is expired.booleanisHidden()Returnstrueif this layout is hidden.booleanReturnstrueif this layout is inactive.booleanReturnstrueif this layout is incomplete.booleanReturnstrueif this layout is layout prototype link enabled.booleanReturnstrueif this layout is pending.booleanReturnstrueif this layout is private layout.booleanReturnstrueif this layout is scheduled.booleanisSystem()Returnstrueif this layout is system.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetClassName(String className) voidsetClassNameId(long classNameId) Sets the class name ID of this layout.voidsetClassPK(long classPK) Sets the class pk of this layout.voidsetColorSchemeId(String colorSchemeId) Sets the color scheme ID of this layout.voidsetCompanyId(long companyId) Sets the company ID of this layout.voidsetCreateDate(Date createDate) Sets the create date of this layout.voidSets the css of this layout.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this layout.voidsetDescription(String description) Sets the description of this layout.voidsetDescription(String description, Locale locale) Sets the localized description of this layout in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this layout in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this layout from the map of locales and localized descriptions.voidsetDescriptionMap(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.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this layout.voidsetFaviconFileEntryId(long faviconFileEntryId) Sets the favicon file entry ID of this layout.voidsetFriendlyURL(String friendlyURL) Sets the friendly url of this layout.voidsetGroupId(long groupId) Sets the group ID of this layout.voidsetHidden(boolean hidden) Sets whether this layout is hidden.voidsetIconImageId(long iconImageId) Sets the icon image ID of this layout.voidsetKeywords(String keywords) Sets the keywords of this layout.voidsetKeywords(String keywords, Locale locale) Sets the localized keywords of this layout in the language.voidsetKeywords(String keywords, Locale locale, Locale defaultLocale) Sets the localized keywords of this layout in the language, and sets the default locale.voidsetKeywordsCurrentLanguageId(String languageId) voidsetKeywordsMap(Map<Locale, String> keywordsMap) Sets the localized keywordses of this layout from the map of locales and localized keywordses.voidsetKeywordsMap(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.voidsetLastPublishDate(Date lastPublishDate) Sets the last publish date of this layout.voidsetLayoutId(long layoutId) Sets the layout ID of this layout.voidsetLayoutPrototypeLinkEnabled(boolean layoutPrototypeLinkEnabled) Sets whether this layout is layout prototype link enabled.voidsetLayoutPrototypeUuid(String layoutPrototypeUuid) Sets the layout prototype uuid of this layout.voidsetMasterLayoutPlid(long masterLayoutPlid) Sets the master layout plid of this layout.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this layout.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this layout.voidSets the name of this layout.voidSets the localized name of this layout in the language.voidSets the localized name of this layout in the language, and sets the default locale.voidsetNameCurrentLanguageId(String languageId) voidsetNameMap(Map<Locale, String> nameMap) Sets the localized names of this layout from the map of locales and localized names.voidsetNameMap(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.voidsetParentLayoutId(long parentLayoutId) Sets the parent layout ID of this layout.voidsetParentPlid(long parentPlid) Sets the parent plid of this layout.voidsetPlid(long plid) Sets the plid of this layout.voidsetPrimaryKey(long primaryKey) Sets the primary key of this layout.voidsetPriority(int priority) Sets the priority of this layout.voidsetPrivateLayout(boolean privateLayout) Sets whether this layout is private layout.voidsetPublishDate(Date publishDate) Sets the publish date of this layout.voidSets the robots of this layout.voidSets the localized robots of this layout in the language.voidSets the localized robots of this layout in the language, and sets the default locale.voidsetRobotsCurrentLanguageId(String languageId) voidsetRobotsMap(Map<Locale, String> robotsMap) Sets the localized robotses of this layout from the map of locales and localized robotses.voidsetRobotsMap(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.voidsetSourcePrototypeLayoutUuid(String sourcePrototypeLayoutUuid) Sets the source prototype layout uuid of this layout.voidsetStatus(int status) Sets the status of this layout.voidsetStatusByUserId(long statusByUserId) Sets the status by user ID of this layout.voidsetStatusByUserName(String statusByUserName) Sets the status by user name of this layout.voidsetStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this layout.voidsetStatusDate(Date statusDate) Sets the status date of this layout.voidsetStyleBookEntryId(long styleBookEntryId) Sets the style book entry ID of this layout.voidsetSystem(boolean system) Sets whether this layout is system.voidsetThemeId(String themeId) Sets the theme ID of this layout.voidSets the title of this layout.voidSets the localized title of this layout in the language.voidSets the localized title of this layout in the language, and sets the default locale.voidsetTitleCurrentLanguageId(String languageId) voidsetTitleMap(Map<Locale, String> titleMap) Sets the localized titles of this layout from the map of locales and localized titles.voidsetTitleMap(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.voidSets the type of this layout.voidsetTypeSettings(String typeSettings) Sets the type settings of this layout.voidsetUserId(long userId) Sets the user ID of this layout.voidsetUserName(String userName) Sets the user name of this layout.voidsetUserUuid(String userUuid) Sets the user uuid of this layout.voidSets the uuid of this layout.default StringMethods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this layout.- Specified by:
getPrimaryKeyin interfaceCTModel<Layout>- Returns:
- the primary key of this layout
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this layout.- Specified by:
setPrimaryKeyin interfaceCTModel<Layout>- Parameters:
primaryKey- the primary key of this layout
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this layout.- Specified by:
getMvccVersionin interfaceMVCCModel- Returns:
- the mvcc version of this layout
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this layout.- Specified by:
setMvccVersionin interfaceMVCCModel- Parameters:
mvccVersion- the mvcc version of this layout
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this layout.- Specified by:
getCtCollectionIdin interfaceCTModel<Layout>- Returns:
- the ct collection ID of this layout
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this layout.- Specified by:
setCtCollectionIdin interfaceCTModel<Layout>- Parameters:
ctCollectionId- the ct collection ID of this layout
-
getUuid
Returns the uuid of this layout.- Specified by:
getUuidin interfaceStagedModel- Returns:
- the uuid of this layout
-
setUuid
Sets the uuid of this layout.- Specified by:
setUuidin interfaceStagedModel- Parameters:
uuid- the uuid of this layout
-
getExternalReferenceCode
Returns the external reference code of this layout.- Specified by:
getExternalReferenceCodein interfaceExternalReferenceCodeModel- Returns:
- the external reference code of this layout
-
setExternalReferenceCode
Sets the external reference code of this layout.- Specified by:
setExternalReferenceCodein interfaceExternalReferenceCodeModel- Parameters:
externalReferenceCode- the external reference code 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:
getGroupIdin interfaceGroupedModel- Returns:
- the group ID of this layout
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this layout.- Specified by:
setGroupIdin interfaceGroupedModel- Parameters:
groupId- the group ID of this layout
-
getCompanyId
long getCompanyId()Returns the company ID of this layout.- Specified by:
getCompanyIdin interfaceAuditedModel- Specified by:
getCompanyIdin interfaceShardedModel- Specified by:
getCompanyIdin interfaceStagedModel- Returns:
- the company ID of this layout
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this layout.- Specified by:
setCompanyIdin interfaceAuditedModel- Specified by:
setCompanyIdin interfaceShardedModel- Specified by:
setCompanyIdin interfaceStagedModel- Parameters:
companyId- the company ID of this layout
-
getUserId
long getUserId()Returns the user ID of this layout.- Specified by:
getUserIdin interfaceAuditedModel- Returns:
- the user ID of this layout
-
setUserId
void setUserId(long userId) Sets the user ID of this layout.- Specified by:
setUserIdin interfaceAuditedModel- Parameters:
userId- the user ID of this layout
-
getUserUuid
String getUserUuid()Returns the user uuid of this layout.- Specified by:
getUserUuidin interfaceAuditedModel- Returns:
- the user uuid of this layout
-
setUserUuid
Sets the user uuid of this layout.- Specified by:
setUserUuidin interfaceAuditedModel- Parameters:
userUuid- the user uuid of this layout
-
getUserName
Returns the user name of this layout.- Specified by:
getUserNamein interfaceAuditedModel- Returns:
- the user name of this layout
-
setUserName
Sets the user name of this layout.- Specified by:
setUserNamein interfaceAuditedModel- Parameters:
userName- the user name of this layout
-
getCreateDate
Date getCreateDate()Returns the create date of this layout.- Specified by:
getCreateDatein interfaceAuditedModel- Specified by:
getCreateDatein interfaceStagedModel- Returns:
- the create date of this layout
-
setCreateDate
Sets the create date of this layout.- Specified by:
setCreateDatein interfaceAuditedModel- Specified by:
setCreateDatein interfaceStagedModel- Parameters:
createDate- the create date of this layout
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this layout.- Specified by:
getModifiedDatein interfaceAuditedModel- Specified by:
getModifiedDatein interfaceStagedModel- Returns:
- the modified date of this layout
-
setModifiedDate
Sets the modified date of this layout.- Specified by:
setModifiedDatein interfaceAuditedModel- Specified by:
setModifiedDatein interfaceStagedModel- Parameters:
modifiedDate- the modified date of this layout
-
getParentPlid
long getParentPlid()Returns the parent plid of this layout.- Returns:
- the parent plid of this layout
-
setParentPlid
void setParentPlid(long parentPlid) Sets the parent plid of this layout.- Parameters:
parentPlid- the parent plid of this layout
-
getPrivateLayout
boolean getPrivateLayout()Returns the private layout of this layout.- Returns:
- the private layout of this layout
-
isPrivateLayout
boolean isPrivateLayout()Returnstrueif this layout is private layout.- Returns:
trueif this layout is private layout;falseotherwise
-
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
-
getClassName
String getClassName()Returns the fully qualified class name of this layout.- Specified by:
getClassNamein interfaceTypedModel- Returns:
- the fully qualified class name of this layout
-
setClassName
-
getClassNameId
long getClassNameId()Returns the class name ID of this layout.- Specified by:
getClassNameIdin interfaceTypedModel- Returns:
- the class name ID of this layout
-
setClassNameId
void setClassNameId(long classNameId) Sets the class name ID of this layout.- Specified by:
setClassNameIdin interfaceTypedModel- Parameters:
classNameId- the class name ID of this layout
-
getClassPK
long getClassPK()Returns the class pk of this layout.- Specified by:
getClassPKin interfaceAttachedModel- Returns:
- the class pk of this layout
-
setClassPK
void setClassPK(long classPK) Sets the class pk of this layout.- Specified by:
setClassPKin interfaceAttachedModel- Parameters:
classPK- the class pk of this layout
-
getName
String getName()Returns the name of this layout.- Returns:
- the name of this layout
-
getName
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this layout. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getName
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this layout
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this layout.- Returns:
- the locales and localized names of this layout
-
setName
Sets the name of this layout.- Parameters:
name- the name of this layout
-
setName
Sets the localized name of this layout in the language.- Parameters:
name- the localized name of this layoutlocale- the locale of the language
-
setName
Sets the localized name of this layout in the language, and sets the default locale.- Parameters:
name- the localized name of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setNameCurrentLanguageId
-
setNameMap
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
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 layoutdefaultLocale- the default locale
-
getTitle
String getTitle()Returns the title of this layout.- Returns:
- the title of this layout
-
getTitle
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized title of this layout. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getTitle
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized title of this layout
-
getTitleCurrentLanguageId
-
getTitleCurrentValue
-
getTitleMap
Returns a map of the locales and localized titles of this layout.- Returns:
- the locales and localized titles of this layout
-
setTitle
Sets the title of this layout.- Parameters:
title- the title of this layout
-
setTitle
Sets the localized title of this layout in the language.- Parameters:
title- the localized title of this layoutlocale- the locale of the language
-
setTitle
Sets the localized title of this layout in the language, and sets the default locale.- Parameters:
title- the localized title of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setTitleCurrentLanguageId
-
setTitleMap
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
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 layoutdefaultLocale- the default locale
-
getDescription
String getDescription()Returns the description of this layout.- Returns:
- the description of this layout
-
getDescription
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this layout. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getDescription
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this layout
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this layout.- Returns:
- the locales and localized descriptions of this layout
-
setDescription
Sets the description of this layout.- Parameters:
description- the description of this layout
-
setDescription
Sets the localized description of this layout in the language.- Parameters:
description- the localized description of this layoutlocale- the locale of the language
-
setDescription
Sets the localized description of this layout in the language, and sets the default locale.- Parameters:
description- the localized description of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
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
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 layoutdefaultLocale- the default locale
-
getKeywords
String getKeywords()Returns the keywords of this layout.- Returns:
- the keywords of this layout
-
getKeywords
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized keywords of this layout. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getKeywords
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized keywords of this layout
-
getKeywordsCurrentLanguageId
-
getKeywordsCurrentValue
-
getKeywordsMap
Returns a map of the locales and localized keywordses of this layout.- Returns:
- the locales and localized keywordses of this layout
-
setKeywords
Sets the keywords of this layout.- Parameters:
keywords- the keywords of this layout
-
setKeywords
Sets the localized keywords of this layout in the language.- Parameters:
keywords- the localized keywords of this layoutlocale- the locale of the language
-
setKeywords
Sets the localized keywords of this layout in the language, and sets the default locale.- Parameters:
keywords- the localized keywords of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setKeywordsCurrentLanguageId
-
setKeywordsMap
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
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 layoutdefaultLocale- the default locale
-
getRobots
String getRobots()Returns the robots of this layout.- Returns:
- the robots of this layout
-
getRobots
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized robots of this layout. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getRobots
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized robots of this layout
-
getRobotsCurrentLanguageId
-
getRobotsCurrentValue
-
getRobotsMap
Returns a map of the locales and localized robotses of this layout.- Returns:
- the locales and localized robotses of this layout
-
setRobots
Sets the robots of this layout.- Parameters:
robots- the robots of this layout
-
setRobots
Sets the localized robots of this layout in the language.- Parameters:
robots- the localized robots of this layoutlocale- the locale of the language
-
setRobots
Sets the localized robots of this layout in the language, and sets the default locale.- Parameters:
robots- the localized robots of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setRobotsCurrentLanguageId
-
setRobotsMap
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
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 layoutdefaultLocale- the default locale
-
getType
Returns the type of this layout.- Returns:
- the type of this layout
-
setType
Sets the type of this layout.- Parameters:
type- the type of this layout
-
getTypeSettings
Returns the type settings of this layout.- Returns:
- the type settings of this layout
-
setTypeSettings
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()Returnstrueif this layout is hidden.- Returns:
trueif this layout is hidden;falseotherwise
-
setHidden
void setHidden(boolean hidden) Sets whether this layout is hidden.- Parameters:
hidden- the hidden of this layout
-
getSystem
boolean getSystem()Returns the system of this layout.- Returns:
- the system of this layout
-
isSystem
boolean isSystem()Returnstrueif this layout is system.- Returns:
trueif this layout is system;falseotherwise
-
setSystem
void setSystem(boolean system) Sets whether this layout is system.- Parameters:
system- the system of this layout
-
getFriendlyURL
Returns the friendly url of this layout.- Returns:
- the friendly url of this layout
-
setFriendlyURL
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
Returns the theme ID of this layout.- Returns:
- the theme ID of this layout
-
setThemeId
Sets the theme ID of this layout.- Parameters:
themeId- the theme ID of this layout
-
getColorSchemeId
Returns the color scheme ID of this layout.- Returns:
- the color scheme ID of this layout
-
setColorSchemeId
Sets the color scheme ID of this layout.- Parameters:
colorSchemeId- the color scheme ID of this layout
-
getStyleBookEntryId
long getStyleBookEntryId()Returns the style book entry ID of this layout.- Returns:
- the style book entry ID of this layout
-
setStyleBookEntryId
void setStyleBookEntryId(long styleBookEntryId) Sets the style book entry ID of this layout.- Parameters:
styleBookEntryId- the style book entry ID of this layout
-
getCss
Returns the css of this layout.- Returns:
- the css of this layout
-
setCss
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
-
getFaviconFileEntryId
long getFaviconFileEntryId()Returns the favicon file entry ID of this layout.- Returns:
- the favicon file entry ID of this layout
-
setFaviconFileEntryId
void setFaviconFileEntryId(long faviconFileEntryId) Sets the favicon file entry ID of this layout.- Parameters:
faviconFileEntryId- the favicon file entry ID of this layout
-
getMasterLayoutPlid
long getMasterLayoutPlid()Returns the master layout plid of this layout.- Returns:
- the master layout plid of this layout
-
setMasterLayoutPlid
void setMasterLayoutPlid(long masterLayoutPlid) Sets the master layout plid of this layout.- Parameters:
masterLayoutPlid- the master layout plid of this layout
-
getLayoutPrototypeUuid
Returns the layout prototype uuid of this layout.- Returns:
- the layout prototype uuid of this layout
-
setLayoutPrototypeUuid
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()Returnstrueif this layout is layout prototype link enabled.- Returns:
trueif this layout is layout prototype link enabled;falseotherwise
-
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
Returns the source prototype layout uuid of this layout.- Returns:
- the source prototype layout uuid of this layout
-
setSourcePrototypeLayoutUuid
Sets the source prototype layout uuid of this layout.- Parameters:
sourcePrototypeLayoutUuid- the source prototype layout uuid of this layout
-
getPublishDate
Date getPublishDate()Returns the publish date of this layout.- Returns:
- the publish date of this layout
-
setPublishDate
Sets the publish date of this layout.- Parameters:
publishDate- the publish date of this layout
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this layout.- Specified by:
getLastPublishDatein interfaceStagedGroupedModel- Returns:
- the last publish date of this layout
-
setLastPublishDate
Sets the last publish date of this layout.- Specified by:
setLastPublishDatein interfaceStagedGroupedModel- Parameters:
lastPublishDate- the last publish date of this layout
-
getStatus
int getStatus()Returns the status of this layout.- Specified by:
getStatusin interfaceWorkflowedModel- Returns:
- the status of this layout
-
setStatus
void setStatus(int status) Sets the status of this layout.- Specified by:
setStatusin interfaceWorkflowedModel- Parameters:
status- the status of this layout
-
getStatusByUserId
long getStatusByUserId()Returns the status by user ID of this layout.- Specified by:
getStatusByUserIdin interfaceWorkflowedModel- Returns:
- the status by user ID of this layout
-
setStatusByUserId
void setStatusByUserId(long statusByUserId) Sets the status by user ID of this layout.- Specified by:
setStatusByUserIdin interfaceWorkflowedModel- Parameters:
statusByUserId- the status by user ID of this layout
-
getStatusByUserUuid
String getStatusByUserUuid()Returns the status by user uuid of this layout.- Specified by:
getStatusByUserUuidin interfaceWorkflowedModel- Returns:
- the status by user uuid of this layout
-
setStatusByUserUuid
Sets the status by user uuid of this layout.- Specified by:
setStatusByUserUuidin interfaceWorkflowedModel- Parameters:
statusByUserUuid- the status by user uuid of this layout
-
getStatusByUserName
Returns the status by user name of this layout.- Specified by:
getStatusByUserNamein interfaceWorkflowedModel- Returns:
- the status by user name of this layout
-
setStatusByUserName
Sets the status by user name of this layout.- Specified by:
setStatusByUserNamein interfaceWorkflowedModel- Parameters:
statusByUserName- the status by user name of this layout
-
getStatusDate
Date getStatusDate()Returns the status date of this layout.- Specified by:
getStatusDatein interfaceWorkflowedModel- Returns:
- the status date of this layout
-
setStatusDate
Sets the status date of this layout.- Specified by:
setStatusDatein interfaceWorkflowedModel- Parameters:
statusDate- the status date of this layout
-
isApproved
boolean isApproved()Returnstrueif this layout is approved.- Specified by:
isApprovedin interfaceWorkflowedModel- Returns:
trueif this layout is approved;falseotherwise
-
isDenied
boolean isDenied()Returnstrueif this layout is denied.- Specified by:
isDeniedin interfaceWorkflowedModel- Returns:
trueif this layout is denied;falseotherwise
-
isDraft
boolean isDraft()Returnstrueif this layout is a draft.- Specified by:
isDraftin interfaceWorkflowedModel- Returns:
trueif this layout is a draft;falseotherwise
-
isExpired
boolean isExpired()Returnstrueif this layout is expired.- Specified by:
isExpiredin interfaceWorkflowedModel- Returns:
trueif this layout is expired;falseotherwise
-
isInactive
boolean isInactive()Returnstrueif this layout is inactive.- Specified by:
isInactivein interfaceWorkflowedModel- Returns:
trueif this layout is inactive;falseotherwise
-
isIncomplete
boolean isIncomplete()Returnstrueif this layout is incomplete.- Specified by:
isIncompletein interfaceWorkflowedModel- Returns:
trueif this layout is incomplete;falseotherwise
-
isPending
boolean isPending()Returnstrueif this layout is pending.- Specified by:
isPendingin interfaceWorkflowedModel- Returns:
trueif this layout is pending;falseotherwise
-
isScheduled
boolean isScheduled()Returnstrueif this layout is scheduled.- Specified by:
isScheduledin interfaceWorkflowedModel- Returns:
trueif this layout is scheduled;falseotherwise
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIdsin interfaceLocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfaceLocalizedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
cloneWithOriginalValues
Layout cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfaceBaseModel<Layout>
-
toXmlString
-