Package com.liferay.portal.kernel.model
Class LayoutWrapper
Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<Layout>
com.liferay.portal.kernel.model.LayoutWrapper
- All Implemented Interfaces:
AttachedModel,AuditedModel,BaseModel<Layout>,CTModel<Layout>,ClassedModel,ExternalReferenceCodeModel,GroupedModel,Layout,LayoutModel,LocalizedModel,ModelWrapper<Layout>,MVCCModel,PersistedModel,ShardedModel,StagedGroupedModel,StagedModel,TypedModel,WorkflowedModel,Serializable,Cloneable,Comparable<Layout>
- Direct Known Subclasses:
VirtualLayout
This class is a wrapper for Layout.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Field Summary
Fields inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
modelFields inherited from interface com.liferay.portal.kernel.model.Layout
LAYOUT_ID_ACCESSOR, PLID_ACCESSOR -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns all layouts that are direct or indirect children of the current layout.longReturns the ID of the topmost parent layout (e.g. n-th parent layout) of the current layout.longReturns the plid of the topmost parent layout (e.g. n-th parent layout) of the current layout.Returns all parent layouts of the current layout.String[]getBreadcrumb(Locale locale) Returns all child layouts of the current layout, independent of user access permissions.getChildren(PermissionChecker permissionChecker) Returns all child layouts of the current layout that the user has permission to access.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 that is configured for the current layout, or the color scheme of the layout set that contains the current layout if no color scheme is configured.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.Returns the CSS text for the current layout, or for the layout set if no CSS text is configured in the current layout.longReturns the ct collection ID of this layout.getDefaultThemeSetting(String key, String device, boolean inheritLookAndFeel) 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.getEmbeddedPortlets(long groupId) Returns the external reference code of this layout.longReturns the favicon file entry ID of this layout.Returns the friendly url of this layout.getFriendlyURL(Locale locale) Returns the layout's friendly URL for the given locale.Returns the friendly URLs for all configured locales.getGroup()Returns the current layout's group.longReturns the group ID of this layout.booleanReturns the hidden of this layout.getHTMLTitle(String localeLanguageId) Returns the current layout's HTML title for the given locale language ID, or the current layout's name if no HTML title is configured.getHTMLTitle(Locale locale) Returns the current layout's HTML title for the given locale, or the current layout's name for the given locale if no HTML title is configured.getIcon()booleanReturnstrueif the current layout has a configured icon.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.Returns the current layout'sLayoutSet.Returns the current layout'sLayoutType.Returns the current layout's linked 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.getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest) getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest) getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest) 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.getTheme()Returns the current layout's theme, or the layout set's theme if no layout theme is configured.Returns the theme ID of this layout.getThemeSetting(String key, String device) getThemeSetting(String key, String device, boolean inheritLookAndFeel) 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.getTypeSettingsProperty(String key, String defaultValue) 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.booleanhasAncestor(long layoutId) Returnstrueif the given layout ID matches one of the current layout's hierarchical parents.booleanReturnstrueif the current layout has child layouts.booleanbooleanbooleanincludeLayoutContent(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) booleanReturnstrueif this layout is approved.booleanisChildSelected(boolean selectable, Layout layout) booleanReturnstrueif the current layout can be used as a content display page.booleanbooleanisDenied()Returnstrueif this layout is denied.booleanisDraft()Returnstrueif this layout is a draft.booleanbooleanbooleanReturnstrueif this layout is expired.booleanReturnstrueif the current layout is the first layout in its parent's hierarchical list of children layouts.booleanReturnstrueif the current layout is the topmost parent layout.booleanisHidden()Returnstrueif this layout is hidden.booleanbooleanReturnstrueif this layout is inactive.booleanReturnstrueif this layout is incomplete.booleanReturnstrueif the current layout utilizes itsLayoutSet's look and feel options (e.g. theme and color scheme).booleanbooleanReturnstrueif the current layout is built from a layout template and still maintains an active connection to it.booleanReturnstrueif this layout is layout prototype link enabled.booleanbooleanbooleanReturnstrueif this layout is pending.booleanisPortletEmbedded(String portletId, long groupId) booleanReturnstrueif this layout is private layout.booleanReturnstrueif the current layout is part of the publicLayoutSet.booleanbooleanReturnstrueif the current layout is the root layout.booleanReturnstrueif this layout is scheduled.booleanisSelected(boolean selectable, Layout layout, long ancestorPlid) booleanReturnstrueif the current layout can hold embedded portlets.booleanisSystem()Returnstrueif this layout is system.booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisUnlocked(String mode, long userId) booleanvoidpersist()Updates this model instance in the database or adds it if it does not yet exist.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.voidsetLayoutSet(LayoutSet layoutSet) voidsetMasterLayoutPlid(long masterLayoutPlid) Sets the master layout plid of this layout.voidsetModelAttributes(Map<String, Object> attributes) 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.voidsetTypeSettingsProperties(UnicodeProperties typeSettingsUnicodeProperties) 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.protected LayoutWrapperMethods inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
clone, compareTo, equals, getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, hashCode, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModelMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, 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.ModelWrapper
getWrappedModelMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone
-
Constructor Details
-
LayoutWrapper
-
-
Method Details
-
getModelAttributes
- Specified by:
getModelAttributesin interfaceBaseModel<Layout>
-
setModelAttributes
- Specified by:
setModelAttributesin interfaceBaseModel<Layout>
-
cloneWithOriginalValues
- Specified by:
cloneWithOriginalValuesin interfaceBaseModel<Layout>- Specified by:
cloneWithOriginalValuesin interfaceLayoutModel
-
fetchDraftLayout
- Specified by:
fetchDraftLayoutin interfaceLayout
-
getAllChildren
Returns all layouts that are direct or indirect children of the current layout.- Specified by:
getAllChildrenin interfaceLayout- Returns:
- the layouts that are direct or indirect children of the current layout
-
getAncestorLayoutId
Returns the ID of the topmost parent layout (e.g. n-th parent layout) of the current layout.- Specified by:
getAncestorLayoutIdin interfaceLayout- Returns:
- the ID of the topmost parent layout of the current layout
- Throws:
PortalException
-
getAncestorPlid
Returns the plid of the topmost parent layout (e.g. n-th parent layout) of the current layout.- Specified by:
getAncestorPlidin interfaceLayout- Returns:
- the plid of the topmost parent layout of the current layout
- Throws:
PortalException
-
getAncestors
Returns all parent layouts of the current layout. The list is retrieved recursively with the direct parent layout listed first, and most distant parent listed last.- Specified by:
getAncestorsin interfaceLayout- Returns:
- the current layout's list of parent layouts
- Throws:
PortalException
-
getAvailableLanguageIds
- Specified by:
getAvailableLanguageIdsin interfaceLayoutModel- Specified by:
getAvailableLanguageIdsin interfaceLocalizedModel
-
getBreadcrumb
- Specified by:
getBreadcrumbin interfaceLayout- Throws:
PortalException
-
getChildren
Returns all child layouts of the current layout, independent of user access permissions.- Specified by:
getChildrenin interfaceLayout- Returns:
- the list of all child layouts
-
getChildren
Returns all child layouts of the current layout that the user has permission to access.- Specified by:
getChildrenin interfaceLayout- Parameters:
permissionChecker- the user-specific context to check permissions- Returns:
- the list of all child layouts that the user has permission to access
- Throws:
PortalException
-
getClassName
Returns the fully qualified class name of this layout.- Specified by:
getClassNamein interfaceLayoutModel- Specified by:
getClassNamein interfaceTypedModel- Returns:
- the fully qualified class name of this layout
-
getClassNameId
public long getClassNameId()Returns the class name ID of this layout.- Specified by:
getClassNameIdin interfaceLayoutModel- Specified by:
getClassNameIdin interfaceTypedModel- Returns:
- the class name ID of this layout
-
getClassPK
public long getClassPK()Returns the class pk of this layout.- Specified by:
getClassPKin interfaceAttachedModel- Specified by:
getClassPKin interfaceLayoutModel- Returns:
- the class pk of this layout
-
getColorScheme
Returns the color scheme that is configured for the current layout, or the color scheme of the layout set that contains the current layout if no color scheme is configured.- Specified by:
getColorSchemein interfaceLayout- Returns:
- the color scheme that is configured for the current layout, or the color scheme of the layout set that contains the current layout if no color scheme is configured
- Throws:
PortalException
-
getColorSchemeId
Returns the color scheme ID of this layout.- Specified by:
getColorSchemeIdin interfaceLayoutModel- Returns:
- the color scheme ID of this layout
-
getCompanyId
public long getCompanyId()Returns the company ID of this layout.- Specified by:
getCompanyIdin interfaceAuditedModel- Specified by:
getCompanyIdin interfaceLayoutModel- Specified by:
getCompanyIdin interfaceShardedModel- Specified by:
getCompanyIdin interfaceStagedModel- Returns:
- the company ID of this layout
-
getCreateDate
Returns the create date of this layout.- Specified by:
getCreateDatein interfaceAuditedModel- Specified by:
getCreateDatein interfaceLayoutModel- Specified by:
getCreateDatein interfaceStagedModel- Returns:
- the create date of this layout
-
getCss
Returns the css of this layout.- Specified by:
getCssin interfaceLayoutModel- Returns:
- the css of this layout
-
getCssText
Returns the CSS text for the current layout, or for the layout set if no CSS text is configured in the current layout.Layouts and layout sets can configure CSS that is applied in addition to the theme's CSS.
- Specified by:
getCssTextin interfaceLayout- Returns:
- the CSS text for the current layout, or for the layout set if no CSS text is configured in the current layout
- Throws:
PortalException
-
getCtCollectionId
public long getCtCollectionId()Returns the ct collection ID of this layout.- Specified by:
getCtCollectionIdin interfaceCTModel<Layout>- Specified by:
getCtCollectionIdin interfaceLayoutModel- Returns:
- the ct collection ID of this layout
-
getDefaultLanguageId
- Specified by:
getDefaultLanguageIdin interfaceLayoutModel- Specified by:
getDefaultLanguageIdin interfaceLocalizedModel
-
getDefaultThemeSetting
- Specified by:
getDefaultThemeSettingin interfaceLayout
-
getDescription
Returns the description of this layout.- Specified by:
getDescriptionin interfaceLayoutModel- 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.- Specified by:
getDescriptionin interfaceLayoutModel- 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.- Specified by:
getDescriptionin interfaceLayoutModel- 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.- Specified by:
getDescriptionin interfaceLayoutModel- 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.- Specified by:
getDescriptionin interfaceLayoutModel- 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
- Specified by:
getDescriptionCurrentLanguageIdin interfaceLayoutModel
-
getDescriptionCurrentValue
- Specified by:
getDescriptionCurrentValuein interfaceLayoutModel
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this layout.- Specified by:
getDescriptionMapin interfaceLayoutModel- Returns:
- the locales and localized descriptions of this layout
-
getEmbeddedPortlets
- Specified by:
getEmbeddedPortletsin interfaceLayout
-
getEmbeddedPortlets
- Specified by:
getEmbeddedPortletsin interfaceLayout
-
getExternalReferenceCode
Returns the external reference code of this layout.- Specified by:
getExternalReferenceCodein interfaceExternalReferenceCodeModel- Specified by:
getExternalReferenceCodein interfaceLayoutModel- Returns:
- the external reference code of this layout
-
getFaviconFileEntryId
public long getFaviconFileEntryId()Returns the favicon file entry ID of this layout.- Specified by:
getFaviconFileEntryIdin interfaceLayoutModel- Returns:
- the favicon file entry ID of this layout
-
getFaviconURL
- Specified by:
getFaviconURLin interfaceLayout
-
getFriendlyURL
Returns the friendly url of this layout.- Specified by:
getFriendlyURLin interfaceLayoutModel- Returns:
- the friendly url of this layout
-
getFriendlyURL
Returns the layout's friendly URL for the given locale.- Specified by:
getFriendlyURLin interfaceLayout- Parameters:
locale- the locale that the friendly URL should be retrieved for- Returns:
- the layout's friendly URL for the given locale
-
getFriendlyURLMap
Returns the friendly URLs for all configured locales.- Specified by:
getFriendlyURLMapin interfaceLayout- Returns:
- the friendly URLs for all configured locales
-
getFriendlyURLsXML
- Specified by:
getFriendlyURLsXMLin interfaceLayout
-
getGroup
Returns the current layout's group.Group is Liferay's technical name for a site.
-
getGroupId
public long getGroupId()Returns the group ID of this layout.- Specified by:
getGroupIdin interfaceGroupedModel- Specified by:
getGroupIdin interfaceLayoutModel- Returns:
- the group ID of this layout
-
getHidden
public boolean getHidden()Returns the hidden of this layout.- Specified by:
getHiddenin interfaceLayoutModel- Returns:
- the hidden of this layout
-
getHTMLTitle
Returns the current layout's HTML title for the given locale, or the current layout's name for the given locale if no HTML title is configured.- Specified by:
getHTMLTitlein interfaceLayout- Parameters:
locale- the locale that the HTML title should be retrieved for- Returns:
- the current layout's HTML title for the given locale, or the current layout's name for the given locale if no HTML title is configured
-
getHTMLTitle
Returns the current layout's HTML title for the given locale language ID, or the current layout's name if no HTML title is configured.- Specified by:
getHTMLTitlein interfaceLayout- Parameters:
localeLanguageId- the locale that the HTML title should be retrieved for- Returns:
- the current layout's HTML title for the given locale language ID, or the current layout's name if no HTML title is configured
-
getIcon
-
getIconImage
public boolean getIconImage()Returnstrueif the current layout has a configured icon.- Specified by:
getIconImagein interfaceLayout- Returns:
trueif the current layout has a configured icon;falseotherwise
-
getIconImageId
public long getIconImageId()Returns the icon image ID of this layout.- Specified by:
getIconImageIdin interfaceLayoutModel- Returns:
- the icon image ID of this layout
-
getKeywords
Returns the keywords of this layout.- Specified by:
getKeywordsin interfaceLayoutModel- 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.- Specified by:
getKeywordsin interfaceLayoutModel- 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.- Specified by:
getKeywordsin interfaceLayoutModel- 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.- Specified by:
getKeywordsin interfaceLayoutModel- 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.- Specified by:
getKeywordsin interfaceLayoutModel- 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
- Specified by:
getKeywordsCurrentLanguageIdin interfaceLayoutModel
-
getKeywordsCurrentValue
- Specified by:
getKeywordsCurrentValuein interfaceLayoutModel
-
getKeywordsMap
Returns a map of the locales and localized keywordses of this layout.- Specified by:
getKeywordsMapin interfaceLayoutModel- Returns:
- the locales and localized keywordses of this layout
-
getLastPublishDate
Returns the last publish date of this layout.- Specified by:
getLastPublishDatein interfaceLayoutModel- Specified by:
getLastPublishDatein interfaceStagedGroupedModel- Returns:
- the last publish date of this layout
-
getLayoutId
public long getLayoutId()Returns the layout ID of this layout.- Specified by:
getLayoutIdin interfaceLayoutModel- Returns:
- the layout ID of this layout
-
getLayoutPrototypeLinkEnabled
public boolean getLayoutPrototypeLinkEnabled()Returns the layout prototype link enabled of this layout.- Specified by:
getLayoutPrototypeLinkEnabledin interfaceLayoutModel- Returns:
- the layout prototype link enabled of this layout
-
getLayoutPrototypeUuid
Returns the layout prototype uuid of this layout.- Specified by:
getLayoutPrototypeUuidin interfaceLayoutModel- Returns:
- the layout prototype uuid of this layout
-
getLayoutSet
Returns the current layout'sLayoutSet.- Specified by:
getLayoutSetin interfaceLayout- Returns:
- the current layout's layout set
-
getLayoutSetPrototypeLayout
- Specified by:
getLayoutSetPrototypeLayoutin interfaceLayout
-
getLayoutType
Returns the current layout'sLayoutType.- Specified by:
getLayoutTypein interfaceLayout- Returns:
- the current layout's layout type
-
getLinkedToLayout
Returns the current layout's linked layout.- Specified by:
getLinkedToLayoutin interfaceLayout- Returns:
- the current layout's linked layout, or
nullif no linked layout could be found
-
getMasterLayoutPlid
public long getMasterLayoutPlid()Returns the master layout plid of this layout.- Specified by:
getMasterLayoutPlidin interfaceLayoutModel- Returns:
- the master layout plid of this layout
-
getModifiedDate
Returns the modified date of this layout.- Specified by:
getModifiedDatein interfaceAuditedModel- Specified by:
getModifiedDatein interfaceLayoutModel- Specified by:
getModifiedDatein interfaceStagedModel- Returns:
- the modified date of this layout
-
getMvccVersion
public long getMvccVersion()Returns the mvcc version of this layout.- Specified by:
getMvccVersionin interfaceLayoutModel- Specified by:
getMvccVersionin interfaceMVCCModel- Returns:
- the mvcc version of this layout
-
getName
Returns the name of this layout.- Specified by:
getNamein interfaceLayoutModel- 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.- Specified by:
getNamein interfaceLayoutModel- 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.- Specified by:
getNamein interfaceLayoutModel- 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.- Specified by:
getNamein interfaceLayoutModel- 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.- Specified by:
getNamein interfaceLayoutModel- 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
- Specified by:
getNameCurrentLanguageIdin interfaceLayoutModel
-
getNameCurrentValue
- Specified by:
getNameCurrentValuein interfaceLayoutModel
-
getNameMap
Returns a map of the locales and localized names of this layout.- Specified by:
getNameMapin interfaceLayoutModel- Returns:
- the locales and localized names of this layout
-
getParentLayoutId
public long getParentLayoutId()Returns the parent layout ID of this layout.- Specified by:
getParentLayoutIdin interfaceLayoutModel- Returns:
- the parent layout ID of this layout
-
getParentPlid
public long getParentPlid()Returns the parent plid of this layout.- Specified by:
getParentPlidin interfaceLayoutModel- Returns:
- the parent plid of this layout
-
getPlid
public long getPlid()Returns the plid of this layout.- Specified by:
getPlidin interfaceLayoutModel- Returns:
- the plid of this layout
-
getPrimaryKey
public long getPrimaryKey()Returns the primary key of this layout.- Specified by:
getPrimaryKeyin interfaceCTModel<Layout>- Specified by:
getPrimaryKeyin interfaceLayoutModel- Returns:
- the primary key of this layout
-
getPriority
public int getPriority()Returns the priority of this layout.- Specified by:
getPriorityin interfaceLayoutModel- Returns:
- the priority of this layout
-
getPrivateLayout
public boolean getPrivateLayout()Returns the private layout of this layout.- Specified by:
getPrivateLayoutin interfaceLayoutModel- Returns:
- the private layout of this layout
-
getPublishDate
Returns the publish date of this layout.- Specified by:
getPublishDatein interfaceLayoutModel- Returns:
- the publish date of this layout
-
getRegularURL
public String getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException - Specified by:
getRegularURLin interfaceLayout- Throws:
PortalException
-
getResetLayoutURL
public String getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException - Specified by:
getResetLayoutURLin interfaceLayout- Throws:
PortalException
-
getResetMaxStateURL
public String getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException - Specified by:
getResetMaxStateURLin interfaceLayout- Throws:
PortalException
-
getRobots
Returns the robots of this layout.- Specified by:
getRobotsin interfaceLayoutModel- 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.- Specified by:
getRobotsin interfaceLayoutModel- 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.- Specified by:
getRobotsin interfaceLayoutModel- 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.- Specified by:
getRobotsin interfaceLayoutModel- 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.- Specified by:
getRobotsin interfaceLayoutModel- 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
- Specified by:
getRobotsCurrentLanguageIdin interfaceLayoutModel
-
getRobotsCurrentValue
- Specified by:
getRobotsCurrentValuein interfaceLayoutModel
-
getRobotsMap
Returns a map of the locales and localized robotses of this layout.- Specified by:
getRobotsMapin interfaceLayoutModel- Returns:
- the locales and localized robotses of this layout
-
getScopeGroup
- Specified by:
getScopeGroupin interfaceLayout- Throws:
PortalException
-
getSourcePrototypeLayoutUuid
Returns the source prototype layout uuid of this layout.- Specified by:
getSourcePrototypeLayoutUuidin interfaceLayoutModel- Returns:
- the source prototype layout uuid of this layout
-
getStatus
public int getStatus()Returns the status of this layout.- Specified by:
getStatusin interfaceLayoutModel- Specified by:
getStatusin interfaceWorkflowedModel- Returns:
- the status of this layout
-
getStatusByUserId
public long getStatusByUserId()Returns the status by user ID of this layout.- Specified by:
getStatusByUserIdin interfaceLayoutModel- Specified by:
getStatusByUserIdin interfaceWorkflowedModel- Returns:
- the status by user ID of this layout
-
getStatusByUserName
Returns the status by user name of this layout.- Specified by:
getStatusByUserNamein interfaceLayoutModel- Specified by:
getStatusByUserNamein interfaceWorkflowedModel- Returns:
- the status by user name of this layout
-
getStatusByUserUuid
Returns the status by user uuid of this layout.- Specified by:
getStatusByUserUuidin interfaceLayoutModel- Specified by:
getStatusByUserUuidin interfaceWorkflowedModel- Returns:
- the status by user uuid of this layout
-
getStatusDate
Returns the status date of this layout.- Specified by:
getStatusDatein interfaceLayoutModel- Specified by:
getStatusDatein interfaceWorkflowedModel- Returns:
- the status date of this layout
-
getStyleBookEntryId
public long getStyleBookEntryId()Returns the style book entry ID of this layout.- Specified by:
getStyleBookEntryIdin interfaceLayoutModel- Returns:
- the style book entry ID of this layout
-
getSystem
public boolean getSystem()Returns the system of this layout.- Specified by:
getSystemin interfaceLayoutModel- Returns:
- the system of this layout
-
getTarget
-
getTheme
Returns the current layout's theme, or the layout set's theme if no layout theme is configured.- Specified by:
getThemein interfaceLayout- Returns:
- the current layout's theme, or the layout set's theme if no layout theme is configured
- Throws:
PortalException
-
getThemeId
Returns the theme ID of this layout.- Specified by:
getThemeIdin interfaceLayoutModel- Returns:
- the theme ID of this layout
-
getThemeSetting
- Specified by:
getThemeSettingin interfaceLayout
-
getThemeSetting
- Specified by:
getThemeSettingin interfaceLayout
-
getTitle
Returns the title of this layout.- Specified by:
getTitlein interfaceLayoutModel- 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.- Specified by:
getTitlein interfaceLayoutModel- 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.- Specified by:
getTitlein interfaceLayoutModel- 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.- Specified by:
getTitlein interfaceLayoutModel- 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.- Specified by:
getTitlein interfaceLayoutModel- 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
- Specified by:
getTitleCurrentLanguageIdin interfaceLayoutModel
-
getTitleCurrentValue
- Specified by:
getTitleCurrentValuein interfaceLayoutModel
-
getTitleMap
Returns a map of the locales and localized titles of this layout.- Specified by:
getTitleMapin interfaceLayoutModel- Returns:
- the locales and localized titles of this layout
-
getType
Returns the type of this layout.- Specified by:
getTypein interfaceLayoutModel- Returns:
- the type of this layout
-
getTypeSettings
Returns the type settings of this layout.- Specified by:
getTypeSettingsin interfaceLayoutModel- Returns:
- the type settings of this layout
-
getTypeSettingsProperties
- Specified by:
getTypeSettingsPropertiesin interfaceLayout
-
getTypeSettingsProperty
- Specified by:
getTypeSettingsPropertyin interfaceLayout
-
getTypeSettingsProperty
- Specified by:
getTypeSettingsPropertyin interfaceLayout
-
getUserId
public long getUserId()Returns the user ID of this layout.- Specified by:
getUserIdin interfaceAuditedModel- Specified by:
getUserIdin interfaceLayoutModel- Returns:
- the user ID of this layout
-
getUserName
Returns the user name of this layout.- Specified by:
getUserNamein interfaceAuditedModel- Specified by:
getUserNamein interfaceLayoutModel- Returns:
- the user name of this layout
-
getUserUuid
Returns the user uuid of this layout.- Specified by:
getUserUuidin interfaceAuditedModel- Specified by:
getUserUuidin interfaceLayoutModel- Returns:
- the user uuid of this layout
-
getUuid
Returns the uuid of this layout.- Specified by:
getUuidin interfaceLayoutModel- Specified by:
getUuidin interfaceStagedModel- Returns:
- the uuid of this layout
-
hasAncestor
Returnstrueif the given layout ID matches one of the current layout's hierarchical parents.- Specified by:
hasAncestorin interfaceLayout- Parameters:
layoutId- the layout ID to search for in the current layout's parent list- Returns:
trueif the given layout ID matches one of the current layout's hierarchical parents;falseotherwise- Throws:
PortalException
-
hasChildren
public boolean hasChildren()Returnstrueif the current layout has child layouts.- Specified by:
hasChildrenin interfaceLayout- Returns:
trueif the current layout has child layouts,falseotherwise
-
hasScopeGroup
- Specified by:
hasScopeGroupin interfaceLayout- Throws:
PortalException
-
hasSetModifiedDate
public boolean hasSetModifiedDate()- Specified by:
hasSetModifiedDatein interfaceLayout
-
includeLayoutContent
public boolean includeLayoutContent(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws Exception - Specified by:
includeLayoutContentin interfaceLayout- Throws:
Exception
-
isApproved
public boolean isApproved()Returnstrueif this layout is approved.- Specified by:
isApprovedin interfaceLayoutModel- Specified by:
isApprovedin interfaceWorkflowedModel- Returns:
trueif this layout is approved;falseotherwise
-
isChildSelected
- Specified by:
isChildSelectedin interfaceLayout- Throws:
PortalException
-
isContentDisplayPage
public boolean isContentDisplayPage()Returnstrueif the current layout can be used as a content display page.A content display page must have an Asset Publisher portlet that is configured as the default Asset Publisher for the layout.
- Specified by:
isContentDisplayPagein interfaceLayout- Returns:
trueif the current layout can be used as a content display page;falseotherwise
-
isCustomizable
public boolean isCustomizable()- Specified by:
isCustomizablein interfaceLayout
-
isDenied
public boolean isDenied()Returnstrueif this layout is denied.- Specified by:
isDeniedin interfaceLayoutModel- Specified by:
isDeniedin interfaceWorkflowedModel- Returns:
trueif this layout is denied;falseotherwise
-
isDraft
public boolean isDraft()Returnstrueif this layout is a draft.- Specified by:
isDraftin interfaceLayoutModel- Specified by:
isDraftin interfaceWorkflowedModel- Returns:
trueif this layout is a draft;falseotherwise
-
isDraftLayout
public boolean isDraftLayout()- Specified by:
isDraftLayoutin interfaceLayout
-
isEmbeddedPersonalApplication
public boolean isEmbeddedPersonalApplication()- Specified by:
isEmbeddedPersonalApplicationin interfaceLayout
-
isExpired
public boolean isExpired()Returnstrueif this layout is expired.- Specified by:
isExpiredin interfaceLayoutModel- Specified by:
isExpiredin interfaceWorkflowedModel- Returns:
trueif this layout is expired;falseotherwise
-
isFirstChild
public boolean isFirstChild()Returnstrueif the current layout is the first layout in its parent's hierarchical list of children layouts.- Specified by:
isFirstChildin interfaceLayout- Returns:
trueif the current layout is the first layout in its parent's hierarchical list of children layouts;falseotherwise
-
isFirstParent
public boolean isFirstParent()Returnstrueif the current layout is the topmost parent layout.- Specified by:
isFirstParentin interfaceLayout- Returns:
trueif the current layout is the topmost parent layout;falseotherwise
-
isHidden
public boolean isHidden()Returnstrueif this layout is hidden.- Specified by:
isHiddenin interfaceLayoutModel- Returns:
trueif this layout is hidden;falseotherwise
-
isIconImage
public boolean isIconImage()- Specified by:
isIconImagein interfaceLayout
-
isInactive
public boolean isInactive()Returnstrueif this layout is inactive.- Specified by:
isInactivein interfaceLayoutModel- Specified by:
isInactivein interfaceWorkflowedModel- Returns:
trueif this layout is inactive;falseotherwise
-
isIncomplete
public boolean isIncomplete()Returnstrueif this layout is incomplete.- Specified by:
isIncompletein interfaceLayoutModel- Specified by:
isIncompletein interfaceWorkflowedModel- Returns:
trueif this layout is incomplete;falseotherwise
-
isInheritLookAndFeel
public boolean isInheritLookAndFeel()Returnstrueif the current layout utilizes itsLayoutSet's look and feel options (e.g. theme and color scheme).- Specified by:
isInheritLookAndFeelin interfaceLayout- Returns:
trueif the current layout utilizes its layout set's look and feel options;falseotherwise
-
isLayoutDeleteable
public boolean isLayoutDeleteable()- Specified by:
isLayoutDeleteablein interfaceLayout
-
isLayoutPrototypeLinkActive
public boolean isLayoutPrototypeLinkActive()Returnstrueif the current layout is built from a layout template and still maintains an active connection to it.- Specified by:
isLayoutPrototypeLinkActivein interfaceLayout- Returns:
trueif the current layout is built from a layout template and still maintains an active connection to it;falseotherwise
-
isLayoutPrototypeLinkEnabled
public boolean isLayoutPrototypeLinkEnabled()Returnstrueif this layout is layout prototype link enabled.- Specified by:
isLayoutPrototypeLinkEnabledin interfaceLayoutModel- Returns:
trueif this layout is layout prototype link enabled;falseotherwise
-
isLayoutSortable
public boolean isLayoutSortable()- Specified by:
isLayoutSortablein interfaceLayout
-
isLayoutUpdateable
public boolean isLayoutUpdateable()- Specified by:
isLayoutUpdateablein interfaceLayout
-
isPending
public boolean isPending()Returnstrueif this layout is pending.- Specified by:
isPendingin interfaceLayoutModel- Specified by:
isPendingin interfaceWorkflowedModel- Returns:
trueif this layout is pending;falseotherwise
-
isPortletEmbedded
- Specified by:
isPortletEmbeddedin interfaceLayout
-
isPrivateLayout
public boolean isPrivateLayout()Returnstrueif this layout is private layout.- Specified by:
isPrivateLayoutin interfaceLayoutModel- Returns:
trueif this layout is private layout;falseotherwise
-
isPublicLayout
public boolean isPublicLayout()Returnstrueif the current layout is part of the publicLayoutSet.Note, the returned value reflects the layout's default access options, not its access permissions.
- Specified by:
isPublicLayoutin interfaceLayout- Returns:
trueif the current layout is part of the public layout set;falseotherwise
-
isPublished
public boolean isPublished()- Specified by:
isPublishedin interfaceLayout
-
isRootLayout
public boolean isRootLayout()Returnstrueif the current layout is the root layout.- Specified by:
isRootLayoutin interfaceLayout- Returns:
trueif the current layout is the root layout;falseotherwise
-
isScheduled
public boolean isScheduled()Returnstrueif this layout is scheduled.- Specified by:
isScheduledin interfaceLayoutModel- Specified by:
isScheduledin interfaceWorkflowedModel- Returns:
trueif this layout is scheduled;falseotherwise
-
isSelected
- Specified by:
isSelectedin interfaceLayout
-
isSupportsEmbeddedPortlets
public boolean isSupportsEmbeddedPortlets()Returnstrueif the current layout can hold embedded portlets.- Specified by:
isSupportsEmbeddedPortletsin interfaceLayout- Returns:
trueif the current layout can hold embedded portlets;falseotherwise
-
isSystem
public boolean isSystem()Returnstrueif this layout is system.- Specified by:
isSystemin interfaceLayoutModel- Returns:
trueif this layout is system;falseotherwise
-
isTypeAssetDisplay
public boolean isTypeAssetDisplay()- Specified by:
isTypeAssetDisplayin interfaceLayout
-
isTypeContent
public boolean isTypeContent()- Specified by:
isTypeContentin interfaceLayout
-
isTypeControlPanel
public boolean isTypeControlPanel()- Specified by:
isTypeControlPanelin interfaceLayout
-
isTypeEmbedded
public boolean isTypeEmbedded()- Specified by:
isTypeEmbeddedin interfaceLayout
-
isTypeLinkToLayout
public boolean isTypeLinkToLayout()- Specified by:
isTypeLinkToLayoutin interfaceLayout
-
isTypePanel
public boolean isTypePanel()- Specified by:
isTypePanelin interfaceLayout
-
isTypePortlet
public boolean isTypePortlet()- Specified by:
isTypePortletin interfaceLayout
-
isTypeURL
public boolean isTypeURL() -
isTypeUtility
public boolean isTypeUtility()- Specified by:
isTypeUtilityin interfaceLayout
-
isUnlocked
- Specified by:
isUnlockedin interfaceLayout
-
matches
public boolean matches(javax.servlet.http.HttpServletRequest httpServletRequest, String friendlyURL) -
persist
public void persist()Description copied from interface:PersistedModelUpdates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.- Specified by:
persistin interfacePersistedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLayoutModel- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLayoutModel- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
setClassName
- Specified by:
setClassNamein interfaceLayoutModel
-
setClassNameId
public void setClassNameId(long classNameId) Sets the class name ID of this layout.- Specified by:
setClassNameIdin interfaceLayoutModel- Specified by:
setClassNameIdin interfaceTypedModel- Parameters:
classNameId- the class name ID of this layout
-
setClassPK
public void setClassPK(long classPK) Sets the class pk of this layout.- Specified by:
setClassPKin interfaceAttachedModel- Specified by:
setClassPKin interfaceLayoutModel- Parameters:
classPK- the class pk of this layout
-
setColorSchemeId
Sets the color scheme ID of this layout.- Specified by:
setColorSchemeIdin interfaceLayoutModel- Parameters:
colorSchemeId- the color scheme ID of this layout
-
setCompanyId
public void setCompanyId(long companyId) Sets the company ID of this layout.- Specified by:
setCompanyIdin interfaceAuditedModel- Specified by:
setCompanyIdin interfaceLayoutModel- Specified by:
setCompanyIdin interfaceShardedModel- Specified by:
setCompanyIdin interfaceStagedModel- Parameters:
companyId- the company ID of this layout
-
setCreateDate
Sets the create date of this layout.- Specified by:
setCreateDatein interfaceAuditedModel- Specified by:
setCreateDatein interfaceLayoutModel- Specified by:
setCreateDatein interfaceStagedModel- Parameters:
createDate- the create date of this layout
-
setCss
Sets the css of this layout.- Specified by:
setCssin interfaceLayoutModel- Parameters:
css- the css of this layout
-
setCtCollectionId
public void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this layout.- Specified by:
setCtCollectionIdin interfaceCTModel<Layout>- Specified by:
setCtCollectionIdin interfaceLayoutModel- Parameters:
ctCollectionId- the ct collection ID of this layout
-
setDescription
Sets the description of this layout.- Specified by:
setDescriptionin interfaceLayoutModel- Parameters:
description- the description of this layout
-
setDescription
Sets the localized description of this layout in the language.- Specified by:
setDescriptionin interfaceLayoutModel- 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.- Specified by:
setDescriptionin interfaceLayoutModel- Parameters:
description- the localized description of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setDescriptionCurrentLanguageId
- Specified by:
setDescriptionCurrentLanguageIdin interfaceLayoutModel
-
setDescriptionMap
Sets the localized descriptions of this layout from the map of locales and localized descriptions.- Specified by:
setDescriptionMapin interfaceLayoutModel- 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.- Specified by:
setDescriptionMapin interfaceLayoutModel- Parameters:
descriptionMap- the locales and localized descriptions of this layoutdefaultLocale- the default locale
-
setExternalReferenceCode
Sets the external reference code of this layout.- Specified by:
setExternalReferenceCodein interfaceExternalReferenceCodeModel- Specified by:
setExternalReferenceCodein interfaceLayoutModel- Parameters:
externalReferenceCode- the external reference code of this layout
-
setFaviconFileEntryId
public void setFaviconFileEntryId(long faviconFileEntryId) Sets the favicon file entry ID of this layout.- Specified by:
setFaviconFileEntryIdin interfaceLayoutModel- Parameters:
faviconFileEntryId- the favicon file entry ID of this layout
-
setFriendlyURL
Sets the friendly url of this layout.- Specified by:
setFriendlyURLin interfaceLayoutModel- Parameters:
friendlyURL- the friendly url of this layout
-
setGroupId
public void setGroupId(long groupId) Sets the group ID of this layout.- Specified by:
setGroupIdin interfaceGroupedModel- Specified by:
setGroupIdin interfaceLayoutModel- Parameters:
groupId- the group ID of this layout
-
setHidden
public void setHidden(boolean hidden) Sets whether this layout is hidden.- Specified by:
setHiddenin interfaceLayoutModel- Parameters:
hidden- the hidden of this layout
-
setIconImageId
public void setIconImageId(long iconImageId) Sets the icon image ID of this layout.- Specified by:
setIconImageIdin interfaceLayoutModel- Parameters:
iconImageId- the icon image ID of this layout
-
setKeywords
Sets the keywords of this layout.- Specified by:
setKeywordsin interfaceLayoutModel- Parameters:
keywords- the keywords of this layout
-
setKeywords
Sets the localized keywords of this layout in the language.- Specified by:
setKeywordsin interfaceLayoutModel- 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.- Specified by:
setKeywordsin interfaceLayoutModel- Parameters:
keywords- the localized keywords of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setKeywordsCurrentLanguageId
- Specified by:
setKeywordsCurrentLanguageIdin interfaceLayoutModel
-
setKeywordsMap
Sets the localized keywordses of this layout from the map of locales and localized keywordses.- Specified by:
setKeywordsMapin interfaceLayoutModel- 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.- Specified by:
setKeywordsMapin interfaceLayoutModel- Parameters:
keywordsMap- the locales and localized keywordses of this layoutdefaultLocale- the default locale
-
setLastPublishDate
Sets the last publish date of this layout.- Specified by:
setLastPublishDatein interfaceLayoutModel- Specified by:
setLastPublishDatein interfaceStagedGroupedModel- Parameters:
lastPublishDate- the last publish date of this layout
-
setLayoutId
public void setLayoutId(long layoutId) Sets the layout ID of this layout.- Specified by:
setLayoutIdin interfaceLayoutModel- Parameters:
layoutId- the layout ID of this layout
-
setLayoutPrototypeLinkEnabled
public void setLayoutPrototypeLinkEnabled(boolean layoutPrototypeLinkEnabled) Sets whether this layout is layout prototype link enabled.- Specified by:
setLayoutPrototypeLinkEnabledin interfaceLayoutModel- Parameters:
layoutPrototypeLinkEnabled- the layout prototype link enabled of this layout
-
setLayoutPrototypeUuid
Sets the layout prototype uuid of this layout.- Specified by:
setLayoutPrototypeUuidin interfaceLayoutModel- Parameters:
layoutPrototypeUuid- the layout prototype uuid of this layout
-
setLayoutSet
- Specified by:
setLayoutSetin interfaceLayout
-
setMasterLayoutPlid
public void setMasterLayoutPlid(long masterLayoutPlid) Sets the master layout plid of this layout.- Specified by:
setMasterLayoutPlidin interfaceLayoutModel- Parameters:
masterLayoutPlid- the master layout plid of this layout
-
setModifiedDate
Sets the modified date of this layout.- Specified by:
setModifiedDatein interfaceAuditedModel- Specified by:
setModifiedDatein interfaceLayoutModel- Specified by:
setModifiedDatein interfaceStagedModel- Parameters:
modifiedDate- the modified date of this layout
-
setMvccVersion
public void setMvccVersion(long mvccVersion) Sets the mvcc version of this layout.- Specified by:
setMvccVersionin interfaceLayoutModel- Specified by:
setMvccVersionin interfaceMVCCModel- Parameters:
mvccVersion- the mvcc version of this layout
-
setName
Sets the name of this layout.- Specified by:
setNamein interfaceLayoutModel- Parameters:
name- the name of this layout
-
setName
Sets the localized name of this layout in the language.- Specified by:
setNamein interfaceLayoutModel- 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.- Specified by:
setNamein interfaceLayoutModel- Parameters:
name- the localized name of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setNameCurrentLanguageId
- Specified by:
setNameCurrentLanguageIdin interfaceLayoutModel
-
setNameMap
Sets the localized names of this layout from the map of locales and localized names.- Specified by:
setNameMapin interfaceLayoutModel- 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.- Specified by:
setNameMapin interfaceLayoutModel- Parameters:
nameMap- the locales and localized names of this layoutdefaultLocale- the default locale
-
setParentLayoutId
public void setParentLayoutId(long parentLayoutId) Sets the parent layout ID of this layout.- Specified by:
setParentLayoutIdin interfaceLayoutModel- Parameters:
parentLayoutId- the parent layout ID of this layout
-
setParentPlid
public void setParentPlid(long parentPlid) Sets the parent plid of this layout.- Specified by:
setParentPlidin interfaceLayoutModel- Parameters:
parentPlid- the parent plid of this layout
-
setPlid
public void setPlid(long plid) Sets the plid of this layout.- Specified by:
setPlidin interfaceLayoutModel- Parameters:
plid- the plid of this layout
-
setPrimaryKey
public void setPrimaryKey(long primaryKey) Sets the primary key of this layout.- Specified by:
setPrimaryKeyin interfaceCTModel<Layout>- Specified by:
setPrimaryKeyin interfaceLayoutModel- Parameters:
primaryKey- the primary key of this layout
-
setPriority
public void setPriority(int priority) Sets the priority of this layout.- Specified by:
setPriorityin interfaceLayoutModel- Parameters:
priority- the priority of this layout
-
setPrivateLayout
public void setPrivateLayout(boolean privateLayout) Sets whether this layout is private layout.- Specified by:
setPrivateLayoutin interfaceLayoutModel- Parameters:
privateLayout- the private layout of this layout
-
setPublishDate
Sets the publish date of this layout.- Specified by:
setPublishDatein interfaceLayoutModel- Parameters:
publishDate- the publish date of this layout
-
setRobots
Sets the robots of this layout.- Specified by:
setRobotsin interfaceLayoutModel- Parameters:
robots- the robots of this layout
-
setRobots
Sets the localized robots of this layout in the language.- Specified by:
setRobotsin interfaceLayoutModel- 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.- Specified by:
setRobotsin interfaceLayoutModel- Parameters:
robots- the localized robots of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setRobotsCurrentLanguageId
- Specified by:
setRobotsCurrentLanguageIdin interfaceLayoutModel
-
setRobotsMap
Sets the localized robotses of this layout from the map of locales and localized robotses.- Specified by:
setRobotsMapin interfaceLayoutModel- 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.- Specified by:
setRobotsMapin interfaceLayoutModel- Parameters:
robotsMap- the locales and localized robotses of this layoutdefaultLocale- the default locale
-
setSourcePrototypeLayoutUuid
Sets the source prototype layout uuid of this layout.- Specified by:
setSourcePrototypeLayoutUuidin interfaceLayoutModel- Parameters:
sourcePrototypeLayoutUuid- the source prototype layout uuid of this layout
-
setStatus
public void setStatus(int status) Sets the status of this layout.- Specified by:
setStatusin interfaceLayoutModel- Specified by:
setStatusin interfaceWorkflowedModel- Parameters:
status- the status of this layout
-
setStatusByUserId
public void setStatusByUserId(long statusByUserId) Sets the status by user ID of this layout.- Specified by:
setStatusByUserIdin interfaceLayoutModel- Specified by:
setStatusByUserIdin interfaceWorkflowedModel- Parameters:
statusByUserId- the status by user ID of this layout
-
setStatusByUserName
Sets the status by user name of this layout.- Specified by:
setStatusByUserNamein interfaceLayoutModel- Specified by:
setStatusByUserNamein interfaceWorkflowedModel- Parameters:
statusByUserName- the status by user name of this layout
-
setStatusByUserUuid
Sets the status by user uuid of this layout.- Specified by:
setStatusByUserUuidin interfaceLayoutModel- Specified by:
setStatusByUserUuidin interfaceWorkflowedModel- Parameters:
statusByUserUuid- the status by user uuid of this layout
-
setStatusDate
Sets the status date of this layout.- Specified by:
setStatusDatein interfaceLayoutModel- Specified by:
setStatusDatein interfaceWorkflowedModel- Parameters:
statusDate- the status date of this layout
-
setStyleBookEntryId
public void setStyleBookEntryId(long styleBookEntryId) Sets the style book entry ID of this layout.- Specified by:
setStyleBookEntryIdin interfaceLayoutModel- Parameters:
styleBookEntryId- the style book entry ID of this layout
-
setSystem
public void setSystem(boolean system) Sets whether this layout is system.- Specified by:
setSystemin interfaceLayoutModel- Parameters:
system- the system of this layout
-
setThemeId
Sets the theme ID of this layout.- Specified by:
setThemeIdin interfaceLayoutModel- Parameters:
themeId- the theme ID of this layout
-
setTitle
Sets the title of this layout.- Specified by:
setTitlein interfaceLayoutModel- Parameters:
title- the title of this layout
-
setTitle
Sets the localized title of this layout in the language.- Specified by:
setTitlein interfaceLayoutModel- 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.- Specified by:
setTitlein interfaceLayoutModel- Parameters:
title- the localized title of this layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setTitleCurrentLanguageId
- Specified by:
setTitleCurrentLanguageIdin interfaceLayoutModel
-
setTitleMap
Sets the localized titles of this layout from the map of locales and localized titles.- Specified by:
setTitleMapin interfaceLayoutModel- 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.- Specified by:
setTitleMapin interfaceLayoutModel- Parameters:
titleMap- the locales and localized titles of this layoutdefaultLocale- the default locale
-
setType
Sets the type of this layout.- Specified by:
setTypein interfaceLayoutModel- Parameters:
type- the type of this layout
-
setTypeSettings
Sets the type settings of this layout.- Specified by:
setTypeSettingsin interfaceLayoutModel- Parameters:
typeSettings- the type settings of this layout
-
setTypeSettingsProperties
- Specified by:
setTypeSettingsPropertiesin interfaceLayout
-
setUserId
public void setUserId(long userId) Sets the user ID of this layout.- Specified by:
setUserIdin interfaceAuditedModel- Specified by:
setUserIdin interfaceLayoutModel- Parameters:
userId- the user ID of this layout
-
setUserName
Sets the user name of this layout.- Specified by:
setUserNamein interfaceAuditedModel- Specified by:
setUserNamein interfaceLayoutModel- Parameters:
userName- the user name of this layout
-
setUserUuid
Sets the user uuid of this layout.- Specified by:
setUserUuidin interfaceAuditedModel- Specified by:
setUserUuidin interfaceLayoutModel- Parameters:
userUuid- the user uuid of this layout
-
setUuid
Sets the uuid of this layout.- Specified by:
setUuidin interfaceLayoutModel- Specified by:
setUuidin interfaceStagedModel- Parameters:
uuid- the uuid of this layout
-
toXmlString
- Specified by:
toXmlStringin interfaceLayoutModel
-
getAttributeGetterFunctions
- Specified by:
getAttributeGetterFunctionsin interfaceBaseModel<Layout>
-
getAttributeSetterBiConsumers
- Specified by:
getAttributeSetterBiConsumersin interfaceBaseModel<Layout>
-
getStagedModelType
- Specified by:
getStagedModelTypein interfaceStagedModel
-
wrap
- Specified by:
wrapin classBaseModelWrapper<Layout>
-