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
model
Fields 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.long
Returns the ID of the topmost parent layout (e.g. n-th parent layout) of the current layout.long
Returns 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.long
Returns the class name ID of this layout.long
Returns 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.long
Returns 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.long
Returns 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.long
Returns 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.long
Returns the group ID of this layout.boolean
Returns 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()
boolean
Returnstrue
if the current layout has a configured icon.long
Returns 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.long
Returns the layout ID of this layout.boolean
Returns 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.long
Returns the master layout plid of this layout.Returns the modified date of this layout.long
Returns 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.long
Returns the parent layout ID of this layout.long
Returns the parent plid of this layout.long
getPlid()
Returns the plid of this layout.long
Returns the primary key of this layout.int
Returns the priority of this layout.boolean
Returns 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.int
Returns the status of this layout.long
Returns 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.long
Returns the style book entry ID of this layout.boolean
Returns 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) long
Returns 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.boolean
hasAncestor
(long layoutId) Returnstrue
if the given layout ID matches one of the current layout's hierarchical parents.boolean
Returnstrue
if the current layout has child layouts.boolean
boolean
boolean
includeLayoutContent
(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) boolean
Returnstrue
if this layout is approved.boolean
isChildSelected
(boolean selectable, Layout layout) boolean
Returnstrue
if the current layout can be used as a content display page.boolean
boolean
isDenied()
Returnstrue
if this layout is denied.boolean
isDraft()
Returnstrue
if this layout is a draft.boolean
boolean
boolean
Returnstrue
if this layout is expired.boolean
Returnstrue
if the current layout is the first layout in its parent's hierarchical list of children layouts.boolean
Returnstrue
if the current layout is the topmost parent layout.boolean
isHidden()
Returnstrue
if this layout is hidden.boolean
boolean
Returnstrue
if this layout is inactive.boolean
Returnstrue
if this layout is incomplete.boolean
Returnstrue
if the current layout utilizes itsLayoutSet
's look and feel options (e.g. theme and color scheme).boolean
boolean
Returnstrue
if the current layout is built from a layout template and still maintains an active connection to it.boolean
Returnstrue
if this layout is layout prototype link enabled.boolean
boolean
boolean
Returnstrue
if this layout is pending.boolean
isPortletEmbedded
(String portletId, long groupId) boolean
Returnstrue
if this layout is private layout.boolean
Returnstrue
if the current layout is part of the publicLayoutSet
.boolean
boolean
Returnstrue
if the current layout is the root layout.boolean
Returnstrue
if this layout is scheduled.boolean
isSelected
(boolean selectable, Layout layout, long ancestorPlid) boolean
Returnstrue
if the current layout can hold embedded portlets.boolean
isSystem()
Returnstrue
if this layout is system.boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isUnlocked
(String mode, long userId) boolean
void
persist()
Updates this model instance in the database or adds it if it does not yet exist.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setClassName
(String className) void
setClassNameId
(long classNameId) Sets the class name ID of this layout.void
setClassPK
(long classPK) Sets the class pk of this layout.void
setColorSchemeId
(String colorSchemeId) Sets the color scheme ID of this layout.void
setCompanyId
(long companyId) Sets the company ID of this layout.void
setCreateDate
(Date createDate) Sets the create date of this layout.void
Sets the css of this layout.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this layout.void
setDescription
(String description) Sets the description of this layout.void
setDescription
(String description, Locale locale) Sets the localized description of this layout in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this layout in the language, and sets the default locale.void
setDescriptionCurrentLanguageId
(String languageId) void
setDescriptionMap
(Map<Locale, String> descriptionMap) Sets the localized descriptions of this layout from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this layout from the map of locales and localized descriptions, and sets the default locale.void
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this layout.void
setFaviconFileEntryId
(long faviconFileEntryId) Sets the favicon file entry ID of this layout.void
setFriendlyURL
(String friendlyURL) Sets the friendly url of this layout.void
setGroupId
(long groupId) Sets the group ID of this layout.void
setHidden
(boolean hidden) Sets whether this layout is hidden.void
setIconImageId
(long iconImageId) Sets the icon image ID of this layout.void
setKeywords
(String keywords) Sets the keywords of this layout.void
setKeywords
(String keywords, Locale locale) Sets the localized keywords of this layout in the language.void
setKeywords
(String keywords, Locale locale, Locale defaultLocale) Sets the localized keywords of this layout in the language, and sets the default locale.void
setKeywordsCurrentLanguageId
(String languageId) void
setKeywordsMap
(Map<Locale, String> keywordsMap) Sets the localized keywordses of this layout from the map of locales and localized keywordses.void
setKeywordsMap
(Map<Locale, String> keywordsMap, Locale defaultLocale) Sets the localized keywordses of this layout from the map of locales and localized keywordses, and sets the default locale.void
setLastPublishDate
(Date lastPublishDate) Sets the last publish date of this layout.void
setLayoutId
(long layoutId) Sets the layout ID of this layout.void
setLayoutPrototypeLinkEnabled
(boolean layoutPrototypeLinkEnabled) Sets whether this layout is layout prototype link enabled.void
setLayoutPrototypeUuid
(String layoutPrototypeUuid) Sets the layout prototype uuid of this layout.void
setLayoutSet
(LayoutSet layoutSet) void
setMasterLayoutPlid
(long masterLayoutPlid) Sets the master layout plid of this layout.void
setModelAttributes
(Map<String, Object> attributes) void
setModifiedDate
(Date modifiedDate) Sets the modified date of this layout.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this layout.void
Sets the name of this layout.void
Sets the localized name of this layout in the language.void
Sets the localized name of this layout in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this layout from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this layout from the map of locales and localized names, and sets the default locale.void
setParentLayoutId
(long parentLayoutId) Sets the parent layout ID of this layout.void
setParentPlid
(long parentPlid) Sets the parent plid of this layout.void
setPlid
(long plid) Sets the plid of this layout.void
setPrimaryKey
(long primaryKey) Sets the primary key of this layout.void
setPriority
(int priority) Sets the priority of this layout.void
setPrivateLayout
(boolean privateLayout) Sets whether this layout is private layout.void
setPublishDate
(Date publishDate) Sets the publish date of this layout.void
Sets the robots of this layout.void
Sets the localized robots of this layout in the language.void
Sets the localized robots of this layout in the language, and sets the default locale.void
setRobotsCurrentLanguageId
(String languageId) void
setRobotsMap
(Map<Locale, String> robotsMap) Sets the localized robotses of this layout from the map of locales and localized robotses.void
setRobotsMap
(Map<Locale, String> robotsMap, Locale defaultLocale) Sets the localized robotses of this layout from the map of locales and localized robotses, and sets the default locale.void
setSourcePrototypeLayoutUuid
(String sourcePrototypeLayoutUuid) Sets the source prototype layout uuid of this layout.void
setStatus
(int status) Sets the status of this layout.void
setStatusByUserId
(long statusByUserId) Sets the status by user ID of this layout.void
setStatusByUserName
(String statusByUserName) Sets the status by user name of this layout.void
setStatusByUserUuid
(String statusByUserUuid) Sets the status by user uuid of this layout.void
setStatusDate
(Date statusDate) Sets the status date of this layout.void
setStyleBookEntryId
(long styleBookEntryId) Sets the style book entry ID of this layout.void
setSystem
(boolean system) Sets whether this layout is system.void
setThemeId
(String themeId) Sets the theme ID of this layout.void
Sets the title of this layout.void
Sets the localized title of this layout in the language.void
Sets the localized title of this layout in the language, and sets the default locale.void
setTitleCurrentLanguageId
(String languageId) void
setTitleMap
(Map<Locale, String> titleMap) Sets the localized titles of this layout from the map of locales and localized titles.void
setTitleMap
(Map<Locale, String> titleMap, Locale defaultLocale) Sets the localized titles of this layout from the map of locales and localized titles, and sets the default locale.void
Sets the type of this layout.void
setTypeSettings
(String typeSettings) Sets the type settings of this layout.void
setTypeSettingsProperties
(UnicodeProperties typeSettingsUnicodeProperties) void
setUserId
(long userId) Sets the user ID of this layout.void
setUserName
(String userName) Sets the user name of this layout.void
setUserUuid
(String userUuid) Sets the user uuid of this layout.void
Sets the uuid of this layout.protected LayoutWrapper
Methods 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, toUnescapedModel
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods 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, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.ModelWrapper
getWrappedModel
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone
-
Constructor Details
-
LayoutWrapper
-
-
Method Details
-
getModelAttributes
- Specified by:
getModelAttributes
in interfaceBaseModel<Layout>
-
setModelAttributes
- Specified by:
setModelAttributes
in interfaceBaseModel<Layout>
-
cloneWithOriginalValues
- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<Layout>
- Specified by:
cloneWithOriginalValues
in interfaceLayoutModel
-
fetchDraftLayout
- Specified by:
fetchDraftLayout
in interfaceLayout
-
getAllChildren
Returns all layouts that are direct or indirect children of the current layout.- Specified by:
getAllChildren
in 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:
getAncestorLayoutId
in 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:
getAncestorPlid
in 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:
getAncestors
in interfaceLayout
- Returns:
- the current layout's list of parent layouts
- Throws:
PortalException
-
getAvailableLanguageIds
- Specified by:
getAvailableLanguageIds
in interfaceLayoutModel
- Specified by:
getAvailableLanguageIds
in interfaceLocalizedModel
-
getBreadcrumb
- Specified by:
getBreadcrumb
in interfaceLayout
- Throws:
PortalException
-
getChildren
Returns all child layouts of the current layout, independent of user access permissions.- Specified by:
getChildren
in 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:
getChildren
in 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:
getClassName
in interfaceLayoutModel
- Specified by:
getClassName
in interfaceTypedModel
- Returns:
- the fully qualified class name of this layout
-
getClassNameId
public long getClassNameId()Returns the class name ID of this layout.- Specified by:
getClassNameId
in interfaceLayoutModel
- Specified by:
getClassNameId
in interfaceTypedModel
- Returns:
- the class name ID of this layout
-
getClassPK
public long getClassPK()Returns the class pk of this layout.- Specified by:
getClassPK
in interfaceAttachedModel
- Specified by:
getClassPK
in 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:
getColorScheme
in 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:
getColorSchemeId
in interfaceLayoutModel
- Returns:
- the color scheme ID of this layout
-
getCompanyId
public long getCompanyId()Returns the company ID of this layout.- Specified by:
getCompanyId
in interfaceAuditedModel
- Specified by:
getCompanyId
in interfaceLayoutModel
- Specified by:
getCompanyId
in interfaceShardedModel
- Specified by:
getCompanyId
in interfaceStagedModel
- Returns:
- the company ID of this layout
-
getCreateDate
Returns the create date of this layout.- Specified by:
getCreateDate
in interfaceAuditedModel
- Specified by:
getCreateDate
in interfaceLayoutModel
- Specified by:
getCreateDate
in interfaceStagedModel
- Returns:
- the create date of this layout
-
getCss
Returns the css of this layout.- Specified by:
getCss
in 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:
getCssText
in 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:
getCtCollectionId
in interfaceCTModel<Layout>
- Specified by:
getCtCollectionId
in interfaceLayoutModel
- Returns:
- the ct collection ID of this layout
-
getDefaultLanguageId
- Specified by:
getDefaultLanguageId
in interfaceLayoutModel
- Specified by:
getDefaultLanguageId
in interfaceLocalizedModel
-
getDefaultThemeSetting
- Specified by:
getDefaultThemeSetting
in interfaceLayout
-
getDescription
Returns the description of this layout.- Specified by:
getDescription
in 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:
getDescription
in 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:
getDescription
in 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
useDefault
isfalse
and 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:
getDescription
in 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:
getDescription
in 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:
getDescriptionCurrentLanguageId
in interfaceLayoutModel
-
getDescriptionCurrentValue
- Specified by:
getDescriptionCurrentValue
in interfaceLayoutModel
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this layout.- Specified by:
getDescriptionMap
in interfaceLayoutModel
- Returns:
- the locales and localized descriptions of this layout
-
getEmbeddedPortlets
- Specified by:
getEmbeddedPortlets
in interfaceLayout
-
getEmbeddedPortlets
- Specified by:
getEmbeddedPortlets
in interfaceLayout
-
getExternalReferenceCode
Returns the external reference code of this layout.- Specified by:
getExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Specified by:
getExternalReferenceCode
in interfaceLayoutModel
- Returns:
- the external reference code of this layout
-
getFaviconFileEntryId
public long getFaviconFileEntryId()Returns the favicon file entry ID of this layout.- Specified by:
getFaviconFileEntryId
in interfaceLayoutModel
- Returns:
- the favicon file entry ID of this layout
-
getFaviconURL
- Specified by:
getFaviconURL
in interfaceLayout
-
getFriendlyURL
Returns the friendly url of this layout.- Specified by:
getFriendlyURL
in interfaceLayoutModel
- Returns:
- the friendly url of this layout
-
getFriendlyURL
Returns the layout's friendly URL for the given locale.- Specified by:
getFriendlyURL
in 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:
getFriendlyURLMap
in interfaceLayout
- Returns:
- the friendly URLs for all configured locales
-
getFriendlyURLsXML
- Specified by:
getFriendlyURLsXML
in 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:
getGroupId
in interfaceGroupedModel
- Specified by:
getGroupId
in interfaceLayoutModel
- Returns:
- the group ID of this layout
-
getHidden
public boolean getHidden()Returns the hidden of this layout.- Specified by:
getHidden
in 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:
getHTMLTitle
in 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:
getHTMLTitle
in 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()Returnstrue
if the current layout has a configured icon.- Specified by:
getIconImage
in interfaceLayout
- Returns:
true
if the current layout has a configured icon;false
otherwise
-
getIconImageId
public long getIconImageId()Returns the icon image ID of this layout.- Specified by:
getIconImageId
in interfaceLayoutModel
- Returns:
- the icon image ID of this layout
-
getKeywords
Returns the keywords of this layout.- Specified by:
getKeywords
in 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:
getKeywords
in 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:
getKeywords
in 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
useDefault
isfalse
and 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:
getKeywords
in 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:
getKeywords
in 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:
getKeywordsCurrentLanguageId
in interfaceLayoutModel
-
getKeywordsCurrentValue
- Specified by:
getKeywordsCurrentValue
in interfaceLayoutModel
-
getKeywordsMap
Returns a map of the locales and localized keywordses of this layout.- Specified by:
getKeywordsMap
in interfaceLayoutModel
- Returns:
- the locales and localized keywordses of this layout
-
getLastPublishDate
Returns the last publish date of this layout.- Specified by:
getLastPublishDate
in interfaceLayoutModel
- Specified by:
getLastPublishDate
in interfaceStagedGroupedModel
- Returns:
- the last publish date of this layout
-
getLayoutId
public long getLayoutId()Returns the layout ID of this layout.- Specified by:
getLayoutId
in interfaceLayoutModel
- Returns:
- the layout ID of this layout
-
getLayoutPrototypeLinkEnabled
public boolean getLayoutPrototypeLinkEnabled()Returns the layout prototype link enabled of this layout.- Specified by:
getLayoutPrototypeLinkEnabled
in interfaceLayoutModel
- Returns:
- the layout prototype link enabled of this layout
-
getLayoutPrototypeUuid
Returns the layout prototype uuid of this layout.- Specified by:
getLayoutPrototypeUuid
in interfaceLayoutModel
- Returns:
- the layout prototype uuid of this layout
-
getLayoutSet
Returns the current layout'sLayoutSet
.- Specified by:
getLayoutSet
in interfaceLayout
- Returns:
- the current layout's layout set
-
getLayoutSetPrototypeLayout
- Specified by:
getLayoutSetPrototypeLayout
in interfaceLayout
-
getLayoutType
Returns the current layout'sLayoutType
.- Specified by:
getLayoutType
in interfaceLayout
- Returns:
- the current layout's layout type
-
getLinkedToLayout
Returns the current layout's linked layout.- Specified by:
getLinkedToLayout
in interfaceLayout
- Returns:
- the current layout's linked layout, or
null
if no linked layout could be found
-
getMasterLayoutPlid
public long getMasterLayoutPlid()Returns the master layout plid of this layout.- Specified by:
getMasterLayoutPlid
in interfaceLayoutModel
- Returns:
- the master layout plid of this layout
-
getModifiedDate
Returns the modified date of this layout.- Specified by:
getModifiedDate
in interfaceAuditedModel
- Specified by:
getModifiedDate
in interfaceLayoutModel
- Specified by:
getModifiedDate
in interfaceStagedModel
- Returns:
- the modified date of this layout
-
getMvccVersion
public long getMvccVersion()Returns the mvcc version of this layout.- Specified by:
getMvccVersion
in interfaceLayoutModel
- Specified by:
getMvccVersion
in interfaceMVCCModel
- Returns:
- the mvcc version of this layout
-
getName
Returns the name of this layout.- Specified by:
getName
in 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:
getName
in 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:
getName
in 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
useDefault
isfalse
and 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:
getName
in 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:
getName
in 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:
getNameCurrentLanguageId
in interfaceLayoutModel
-
getNameCurrentValue
- Specified by:
getNameCurrentValue
in interfaceLayoutModel
-
getNameMap
Returns a map of the locales and localized names of this layout.- Specified by:
getNameMap
in interfaceLayoutModel
- Returns:
- the locales and localized names of this layout
-
getParentLayoutId
public long getParentLayoutId()Returns the parent layout ID of this layout.- Specified by:
getParentLayoutId
in interfaceLayoutModel
- Returns:
- the parent layout ID of this layout
-
getParentPlid
public long getParentPlid()Returns the parent plid of this layout.- Specified by:
getParentPlid
in interfaceLayoutModel
- Returns:
- the parent plid of this layout
-
getPlid
public long getPlid()Returns the plid of this layout.- Specified by:
getPlid
in interfaceLayoutModel
- Returns:
- the plid of this layout
-
getPrimaryKey
public long getPrimaryKey()Returns the primary key of this layout.- Specified by:
getPrimaryKey
in interfaceCTModel<Layout>
- Specified by:
getPrimaryKey
in interfaceLayoutModel
- Returns:
- the primary key of this layout
-
getPriority
public int getPriority()Returns the priority of this layout.- Specified by:
getPriority
in interfaceLayoutModel
- Returns:
- the priority of this layout
-
getPrivateLayout
public boolean getPrivateLayout()Returns the private layout of this layout.- Specified by:
getPrivateLayout
in interfaceLayoutModel
- Returns:
- the private layout of this layout
-
getPublishDate
Returns the publish date of this layout.- Specified by:
getPublishDate
in interfaceLayoutModel
- Returns:
- the publish date of this layout
-
getRegularURL
public String getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException - Specified by:
getRegularURL
in interfaceLayout
- Throws:
PortalException
-
getResetLayoutURL
public String getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException - Specified by:
getResetLayoutURL
in interfaceLayout
- Throws:
PortalException
-
getResetMaxStateURL
public String getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException - Specified by:
getResetMaxStateURL
in interfaceLayout
- Throws:
PortalException
-
getRobots
Returns the robots of this layout.- Specified by:
getRobots
in 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:
getRobots
in 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:
getRobots
in 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
useDefault
isfalse
and 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:
getRobots
in 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:
getRobots
in 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:
getRobotsCurrentLanguageId
in interfaceLayoutModel
-
getRobotsCurrentValue
- Specified by:
getRobotsCurrentValue
in interfaceLayoutModel
-
getRobotsMap
Returns a map of the locales and localized robotses of this layout.- Specified by:
getRobotsMap
in interfaceLayoutModel
- Returns:
- the locales and localized robotses of this layout
-
getScopeGroup
- Specified by:
getScopeGroup
in interfaceLayout
- Throws:
PortalException
-
getSourcePrototypeLayoutUuid
Returns the source prototype layout uuid of this layout.- Specified by:
getSourcePrototypeLayoutUuid
in interfaceLayoutModel
- Returns:
- the source prototype layout uuid of this layout
-
getStatus
public int getStatus()Returns the status of this layout.- Specified by:
getStatus
in interfaceLayoutModel
- Specified by:
getStatus
in interfaceWorkflowedModel
- Returns:
- the status of this layout
-
getStatusByUserId
public long getStatusByUserId()Returns the status by user ID of this layout.- Specified by:
getStatusByUserId
in interfaceLayoutModel
- Specified by:
getStatusByUserId
in interfaceWorkflowedModel
- Returns:
- the status by user ID of this layout
-
getStatusByUserName
Returns the status by user name of this layout.- Specified by:
getStatusByUserName
in interfaceLayoutModel
- Specified by:
getStatusByUserName
in interfaceWorkflowedModel
- Returns:
- the status by user name of this layout
-
getStatusByUserUuid
Returns the status by user uuid of this layout.- Specified by:
getStatusByUserUuid
in interfaceLayoutModel
- Specified by:
getStatusByUserUuid
in interfaceWorkflowedModel
- Returns:
- the status by user uuid of this layout
-
getStatusDate
Returns the status date of this layout.- Specified by:
getStatusDate
in interfaceLayoutModel
- Specified by:
getStatusDate
in interfaceWorkflowedModel
- Returns:
- the status date of this layout
-
getStyleBookEntryId
public long getStyleBookEntryId()Returns the style book entry ID of this layout.- Specified by:
getStyleBookEntryId
in interfaceLayoutModel
- Returns:
- the style book entry ID of this layout
-
getSystem
public boolean getSystem()Returns the system of this layout.- Specified by:
getSystem
in 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:
getTheme
in 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:
getThemeId
in interfaceLayoutModel
- Returns:
- the theme ID of this layout
-
getThemeSetting
- Specified by:
getThemeSetting
in interfaceLayout
-
getThemeSetting
- Specified by:
getThemeSetting
in interfaceLayout
-
getTitle
Returns the title of this layout.- Specified by:
getTitle
in 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:
getTitle
in 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:
getTitle
in 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
useDefault
isfalse
and 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:
getTitle
in 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:
getTitle
in 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:
getTitleCurrentLanguageId
in interfaceLayoutModel
-
getTitleCurrentValue
- Specified by:
getTitleCurrentValue
in interfaceLayoutModel
-
getTitleMap
Returns a map of the locales and localized titles of this layout.- Specified by:
getTitleMap
in interfaceLayoutModel
- Returns:
- the locales and localized titles of this layout
-
getType
Returns the type of this layout.- Specified by:
getType
in interfaceLayoutModel
- Returns:
- the type of this layout
-
getTypeSettings
Returns the type settings of this layout.- Specified by:
getTypeSettings
in interfaceLayoutModel
- Returns:
- the type settings of this layout
-
getTypeSettingsProperties
- Specified by:
getTypeSettingsProperties
in interfaceLayout
-
getTypeSettingsProperty
- Specified by:
getTypeSettingsProperty
in interfaceLayout
-
getTypeSettingsProperty
- Specified by:
getTypeSettingsProperty
in interfaceLayout
-
getUserId
public long getUserId()Returns the user ID of this layout.- Specified by:
getUserId
in interfaceAuditedModel
- Specified by:
getUserId
in interfaceLayoutModel
- Returns:
- the user ID of this layout
-
getUserName
Returns the user name of this layout.- Specified by:
getUserName
in interfaceAuditedModel
- Specified by:
getUserName
in interfaceLayoutModel
- Returns:
- the user name of this layout
-
getUserUuid
Returns the user uuid of this layout.- Specified by:
getUserUuid
in interfaceAuditedModel
- Specified by:
getUserUuid
in interfaceLayoutModel
- Returns:
- the user uuid of this layout
-
getUuid
Returns the uuid of this layout.- Specified by:
getUuid
in interfaceLayoutModel
- Specified by:
getUuid
in interfaceStagedModel
- Returns:
- the uuid of this layout
-
hasAncestor
Returnstrue
if the given layout ID matches one of the current layout's hierarchical parents.- Specified by:
hasAncestor
in interfaceLayout
- Parameters:
layoutId
- the layout ID to search for in the current layout's parent list- Returns:
true
if the given layout ID matches one of the current layout's hierarchical parents;false
otherwise- Throws:
PortalException
-
hasChildren
public boolean hasChildren()Returnstrue
if the current layout has child layouts.- Specified by:
hasChildren
in interfaceLayout
- Returns:
true
if the current layout has child layouts,false
otherwise
-
hasScopeGroup
- Specified by:
hasScopeGroup
in interfaceLayout
- Throws:
PortalException
-
hasSetModifiedDate
public boolean hasSetModifiedDate()- Specified by:
hasSetModifiedDate
in interfaceLayout
-
includeLayoutContent
public boolean includeLayoutContent(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws Exception - Specified by:
includeLayoutContent
in interfaceLayout
- Throws:
Exception
-
isApproved
public boolean isApproved()Returnstrue
if this layout is approved.- Specified by:
isApproved
in interfaceLayoutModel
- Specified by:
isApproved
in interfaceWorkflowedModel
- Returns:
true
if this layout is approved;false
otherwise
-
isChildSelected
- Specified by:
isChildSelected
in interfaceLayout
- Throws:
PortalException
-
isContentDisplayPage
public boolean isContentDisplayPage()Returnstrue
if 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:
isContentDisplayPage
in interfaceLayout
- Returns:
true
if the current layout can be used as a content display page;false
otherwise
-
isCustomizable
public boolean isCustomizable()- Specified by:
isCustomizable
in interfaceLayout
-
isDenied
public boolean isDenied()Returnstrue
if this layout is denied.- Specified by:
isDenied
in interfaceLayoutModel
- Specified by:
isDenied
in interfaceWorkflowedModel
- Returns:
true
if this layout is denied;false
otherwise
-
isDraft
public boolean isDraft()Returnstrue
if this layout is a draft.- Specified by:
isDraft
in interfaceLayoutModel
- Specified by:
isDraft
in interfaceWorkflowedModel
- Returns:
true
if this layout is a draft;false
otherwise
-
isDraftLayout
public boolean isDraftLayout()- Specified by:
isDraftLayout
in interfaceLayout
-
isEmbeddedPersonalApplication
public boolean isEmbeddedPersonalApplication()- Specified by:
isEmbeddedPersonalApplication
in interfaceLayout
-
isExpired
public boolean isExpired()Returnstrue
if this layout is expired.- Specified by:
isExpired
in interfaceLayoutModel
- Specified by:
isExpired
in interfaceWorkflowedModel
- Returns:
true
if this layout is expired;false
otherwise
-
isFirstChild
public boolean isFirstChild()Returnstrue
if the current layout is the first layout in its parent's hierarchical list of children layouts.- Specified by:
isFirstChild
in interfaceLayout
- Returns:
true
if the current layout is the first layout in its parent's hierarchical list of children layouts;false
otherwise
-
isFirstParent
public boolean isFirstParent()Returnstrue
if the current layout is the topmost parent layout.- Specified by:
isFirstParent
in interfaceLayout
- Returns:
true
if the current layout is the topmost parent layout;false
otherwise
-
isHidden
public boolean isHidden()Returnstrue
if this layout is hidden.- Specified by:
isHidden
in interfaceLayoutModel
- Returns:
true
if this layout is hidden;false
otherwise
-
isIconImage
public boolean isIconImage()- Specified by:
isIconImage
in interfaceLayout
-
isInactive
public boolean isInactive()Returnstrue
if this layout is inactive.- Specified by:
isInactive
in interfaceLayoutModel
- Specified by:
isInactive
in interfaceWorkflowedModel
- Returns:
true
if this layout is inactive;false
otherwise
-
isIncomplete
public boolean isIncomplete()Returnstrue
if this layout is incomplete.- Specified by:
isIncomplete
in interfaceLayoutModel
- Specified by:
isIncomplete
in interfaceWorkflowedModel
- Returns:
true
if this layout is incomplete;false
otherwise
-
isInheritLookAndFeel
public boolean isInheritLookAndFeel()Returnstrue
if the current layout utilizes itsLayoutSet
's look and feel options (e.g. theme and color scheme).- Specified by:
isInheritLookAndFeel
in interfaceLayout
- Returns:
true
if the current layout utilizes its layout set's look and feel options;false
otherwise
-
isLayoutDeleteable
public boolean isLayoutDeleteable()- Specified by:
isLayoutDeleteable
in interfaceLayout
-
isLayoutPrototypeLinkActive
public boolean isLayoutPrototypeLinkActive()Returnstrue
if the current layout is built from a layout template and still maintains an active connection to it.- Specified by:
isLayoutPrototypeLinkActive
in interfaceLayout
- Returns:
true
if the current layout is built from a layout template and still maintains an active connection to it;false
otherwise
-
isLayoutPrototypeLinkEnabled
public boolean isLayoutPrototypeLinkEnabled()Returnstrue
if this layout is layout prototype link enabled.- Specified by:
isLayoutPrototypeLinkEnabled
in interfaceLayoutModel
- Returns:
true
if this layout is layout prototype link enabled;false
otherwise
-
isLayoutSortable
public boolean isLayoutSortable()- Specified by:
isLayoutSortable
in interfaceLayout
-
isLayoutUpdateable
public boolean isLayoutUpdateable()- Specified by:
isLayoutUpdateable
in interfaceLayout
-
isPending
public boolean isPending()Returnstrue
if this layout is pending.- Specified by:
isPending
in interfaceLayoutModel
- Specified by:
isPending
in interfaceWorkflowedModel
- Returns:
true
if this layout is pending;false
otherwise
-
isPortletEmbedded
- Specified by:
isPortletEmbedded
in interfaceLayout
-
isPrivateLayout
public boolean isPrivateLayout()Returnstrue
if this layout is private layout.- Specified by:
isPrivateLayout
in interfaceLayoutModel
- Returns:
true
if this layout is private layout;false
otherwise
-
isPublicLayout
public boolean isPublicLayout()Returnstrue
if 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:
isPublicLayout
in interfaceLayout
- Returns:
true
if the current layout is part of the public layout set;false
otherwise
-
isPublished
public boolean isPublished()- Specified by:
isPublished
in interfaceLayout
-
isRootLayout
public boolean isRootLayout()Returnstrue
if the current layout is the root layout.- Specified by:
isRootLayout
in interfaceLayout
- Returns:
true
if the current layout is the root layout;false
otherwise
-
isScheduled
public boolean isScheduled()Returnstrue
if this layout is scheduled.- Specified by:
isScheduled
in interfaceLayoutModel
- Specified by:
isScheduled
in interfaceWorkflowedModel
- Returns:
true
if this layout is scheduled;false
otherwise
-
isSelected
- Specified by:
isSelected
in interfaceLayout
-
isSupportsEmbeddedPortlets
public boolean isSupportsEmbeddedPortlets()Returnstrue
if the current layout can hold embedded portlets.- Specified by:
isSupportsEmbeddedPortlets
in interfaceLayout
- Returns:
true
if the current layout can hold embedded portlets;false
otherwise
-
isSystem
public boolean isSystem()Returnstrue
if this layout is system.- Specified by:
isSystem
in interfaceLayoutModel
- Returns:
true
if this layout is system;false
otherwise
-
isTypeAssetDisplay
public boolean isTypeAssetDisplay()- Specified by:
isTypeAssetDisplay
in interfaceLayout
-
isTypeContent
public boolean isTypeContent()- Specified by:
isTypeContent
in interfaceLayout
-
isTypeControlPanel
public boolean isTypeControlPanel()- Specified by:
isTypeControlPanel
in interfaceLayout
-
isTypeEmbedded
public boolean isTypeEmbedded()- Specified by:
isTypeEmbedded
in interfaceLayout
-
isTypeLinkToLayout
public boolean isTypeLinkToLayout()- Specified by:
isTypeLinkToLayout
in interfaceLayout
-
isTypePanel
public boolean isTypePanel()- Specified by:
isTypePanel
in interfaceLayout
-
isTypePortlet
public boolean isTypePortlet()- Specified by:
isTypePortlet
in interfaceLayout
-
isTypeURL
public boolean isTypeURL() -
isTypeUtility
public boolean isTypeUtility()- Specified by:
isTypeUtility
in interfaceLayout
-
isUnlocked
- Specified by:
isUnlocked
in interfaceLayout
-
matches
public boolean matches(javax.servlet.http.HttpServletRequest httpServletRequest, String friendlyURL) -
persist
public void persist()Description copied from interface:PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.- Specified by:
persist
in interfacePersistedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLayoutModel
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLocalizedModel
- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLayoutModel
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLocalizedModel
- Throws:
LocaleException
-
setClassName
- Specified by:
setClassName
in interfaceLayoutModel
-
setClassNameId
public void setClassNameId(long classNameId) Sets the class name ID of this layout.- Specified by:
setClassNameId
in interfaceLayoutModel
- Specified by:
setClassNameId
in 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:
setClassPK
in interfaceAttachedModel
- Specified by:
setClassPK
in interfaceLayoutModel
- Parameters:
classPK
- the class pk of this layout
-
setColorSchemeId
Sets the color scheme ID of this layout.- Specified by:
setColorSchemeId
in 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:
setCompanyId
in interfaceAuditedModel
- Specified by:
setCompanyId
in interfaceLayoutModel
- Specified by:
setCompanyId
in interfaceShardedModel
- Specified by:
setCompanyId
in interfaceStagedModel
- Parameters:
companyId
- the company ID of this layout
-
setCreateDate
Sets the create date of this layout.- Specified by:
setCreateDate
in interfaceAuditedModel
- Specified by:
setCreateDate
in interfaceLayoutModel
- Specified by:
setCreateDate
in interfaceStagedModel
- Parameters:
createDate
- the create date of this layout
-
setCss
Sets the css of this layout.- Specified by:
setCss
in interfaceLayoutModel
- Parameters:
css
- the css of this layout
-
setCtCollectionId
public void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this layout.- Specified by:
setCtCollectionId
in interfaceCTModel<Layout>
- Specified by:
setCtCollectionId
in interfaceLayoutModel
- Parameters:
ctCollectionId
- the ct collection ID of this layout
-
setDescription
Sets the description of this layout.- Specified by:
setDescription
in interfaceLayoutModel
- Parameters:
description
- the description of this layout
-
setDescription
Sets the localized description of this layout in the language.- Specified by:
setDescription
in 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:
setDescription
in interfaceLayoutModel
- Parameters:
description
- the localized description of this layoutlocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
- Specified by:
setDescriptionCurrentLanguageId
in interfaceLayoutModel
-
setDescriptionMap
Sets the localized descriptions of this layout from the map of locales and localized descriptions.- Specified by:
setDescriptionMap
in 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:
setDescriptionMap
in 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:
setExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Specified by:
setExternalReferenceCode
in 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:
setFaviconFileEntryId
in interfaceLayoutModel
- Parameters:
faviconFileEntryId
- the favicon file entry ID of this layout
-
setFriendlyURL
Sets the friendly url of this layout.- Specified by:
setFriendlyURL
in interfaceLayoutModel
- Parameters:
friendlyURL
- the friendly url of this layout
-
setGroupId
public void setGroupId(long groupId) Sets the group ID of this layout.- Specified by:
setGroupId
in interfaceGroupedModel
- Specified by:
setGroupId
in interfaceLayoutModel
- Parameters:
groupId
- the group ID of this layout
-
setHidden
public void setHidden(boolean hidden) Sets whether this layout is hidden.- Specified by:
setHidden
in interfaceLayoutModel
- Parameters:
hidden
- the hidden of this layout
-
setIconImageId
public void setIconImageId(long iconImageId) Sets the icon image ID of this layout.- Specified by:
setIconImageId
in interfaceLayoutModel
- Parameters:
iconImageId
- the icon image ID of this layout
-
setKeywords
Sets the keywords of this layout.- Specified by:
setKeywords
in interfaceLayoutModel
- Parameters:
keywords
- the keywords of this layout
-
setKeywords
Sets the localized keywords of this layout in the language.- Specified by:
setKeywords
in 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:
setKeywords
in interfaceLayoutModel
- Parameters:
keywords
- the localized keywords of this layoutlocale
- the locale of the languagedefaultLocale
- the default locale
-
setKeywordsCurrentLanguageId
- Specified by:
setKeywordsCurrentLanguageId
in interfaceLayoutModel
-
setKeywordsMap
Sets the localized keywordses of this layout from the map of locales and localized keywordses.- Specified by:
setKeywordsMap
in 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:
setKeywordsMap
in 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:
setLastPublishDate
in interfaceLayoutModel
- Specified by:
setLastPublishDate
in 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:
setLayoutId
in 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:
setLayoutPrototypeLinkEnabled
in interfaceLayoutModel
- Parameters:
layoutPrototypeLinkEnabled
- the layout prototype link enabled of this layout
-
setLayoutPrototypeUuid
Sets the layout prototype uuid of this layout.- Specified by:
setLayoutPrototypeUuid
in interfaceLayoutModel
- Parameters:
layoutPrototypeUuid
- the layout prototype uuid of this layout
-
setLayoutSet
- Specified by:
setLayoutSet
in interfaceLayout
-
setMasterLayoutPlid
public void setMasterLayoutPlid(long masterLayoutPlid) Sets the master layout plid of this layout.- Specified by:
setMasterLayoutPlid
in interfaceLayoutModel
- Parameters:
masterLayoutPlid
- the master layout plid of this layout
-
setModifiedDate
Sets the modified date of this layout.- Specified by:
setModifiedDate
in interfaceAuditedModel
- Specified by:
setModifiedDate
in interfaceLayoutModel
- Specified by:
setModifiedDate
in interfaceStagedModel
- Parameters:
modifiedDate
- the modified date of this layout
-
setMvccVersion
public void setMvccVersion(long mvccVersion) Sets the mvcc version of this layout.- Specified by:
setMvccVersion
in interfaceLayoutModel
- Specified by:
setMvccVersion
in interfaceMVCCModel
- Parameters:
mvccVersion
- the mvcc version of this layout
-
setName
Sets the name of this layout.- Specified by:
setName
in interfaceLayoutModel
- Parameters:
name
- the name of this layout
-
setName
Sets the localized name of this layout in the language.- Specified by:
setName
in 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:
setName
in interfaceLayoutModel
- Parameters:
name
- the localized name of this layoutlocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
- Specified by:
setNameCurrentLanguageId
in interfaceLayoutModel
-
setNameMap
Sets the localized names of this layout from the map of locales and localized names.- Specified by:
setNameMap
in 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:
setNameMap
in 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:
setParentLayoutId
in 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:
setParentPlid
in interfaceLayoutModel
- Parameters:
parentPlid
- the parent plid of this layout
-
setPlid
public void setPlid(long plid) Sets the plid of this layout.- Specified by:
setPlid
in interfaceLayoutModel
- Parameters:
plid
- the plid of this layout
-
setPrimaryKey
public void setPrimaryKey(long primaryKey) Sets the primary key of this layout.- Specified by:
setPrimaryKey
in interfaceCTModel<Layout>
- Specified by:
setPrimaryKey
in interfaceLayoutModel
- Parameters:
primaryKey
- the primary key of this layout
-
setPriority
public void setPriority(int priority) Sets the priority of this layout.- Specified by:
setPriority
in interfaceLayoutModel
- Parameters:
priority
- the priority of this layout
-
setPrivateLayout
public void setPrivateLayout(boolean privateLayout) Sets whether this layout is private layout.- Specified by:
setPrivateLayout
in interfaceLayoutModel
- Parameters:
privateLayout
- the private layout of this layout
-
setPublishDate
Sets the publish date of this layout.- Specified by:
setPublishDate
in interfaceLayoutModel
- Parameters:
publishDate
- the publish date of this layout
-
setRobots
Sets the robots of this layout.- Specified by:
setRobots
in interfaceLayoutModel
- Parameters:
robots
- the robots of this layout
-
setRobots
Sets the localized robots of this layout in the language.- Specified by:
setRobots
in 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:
setRobots
in interfaceLayoutModel
- Parameters:
robots
- the localized robots of this layoutlocale
- the locale of the languagedefaultLocale
- the default locale
-
setRobotsCurrentLanguageId
- Specified by:
setRobotsCurrentLanguageId
in interfaceLayoutModel
-
setRobotsMap
Sets the localized robotses of this layout from the map of locales and localized robotses.- Specified by:
setRobotsMap
in 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:
setRobotsMap
in 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:
setSourcePrototypeLayoutUuid
in 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:
setStatus
in interfaceLayoutModel
- Specified by:
setStatus
in 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:
setStatusByUserId
in interfaceLayoutModel
- Specified by:
setStatusByUserId
in interfaceWorkflowedModel
- Parameters:
statusByUserId
- the status by user ID of this layout
-
setStatusByUserName
Sets the status by user name of this layout.- Specified by:
setStatusByUserName
in interfaceLayoutModel
- Specified by:
setStatusByUserName
in interfaceWorkflowedModel
- Parameters:
statusByUserName
- the status by user name of this layout
-
setStatusByUserUuid
Sets the status by user uuid of this layout.- Specified by:
setStatusByUserUuid
in interfaceLayoutModel
- Specified by:
setStatusByUserUuid
in interfaceWorkflowedModel
- Parameters:
statusByUserUuid
- the status by user uuid of this layout
-
setStatusDate
Sets the status date of this layout.- Specified by:
setStatusDate
in interfaceLayoutModel
- Specified by:
setStatusDate
in 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:
setStyleBookEntryId
in 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:
setSystem
in interfaceLayoutModel
- Parameters:
system
- the system of this layout
-
setThemeId
Sets the theme ID of this layout.- Specified by:
setThemeId
in interfaceLayoutModel
- Parameters:
themeId
- the theme ID of this layout
-
setTitle
Sets the title of this layout.- Specified by:
setTitle
in interfaceLayoutModel
- Parameters:
title
- the title of this layout
-
setTitle
Sets the localized title of this layout in the language.- Specified by:
setTitle
in 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:
setTitle
in interfaceLayoutModel
- Parameters:
title
- the localized title of this layoutlocale
- the locale of the languagedefaultLocale
- the default locale
-
setTitleCurrentLanguageId
- Specified by:
setTitleCurrentLanguageId
in interfaceLayoutModel
-
setTitleMap
Sets the localized titles of this layout from the map of locales and localized titles.- Specified by:
setTitleMap
in 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:
setTitleMap
in interfaceLayoutModel
- Parameters:
titleMap
- the locales and localized titles of this layoutdefaultLocale
- the default locale
-
setType
Sets the type of this layout.- Specified by:
setType
in interfaceLayoutModel
- Parameters:
type
- the type of this layout
-
setTypeSettings
Sets the type settings of this layout.- Specified by:
setTypeSettings
in interfaceLayoutModel
- Parameters:
typeSettings
- the type settings of this layout
-
setTypeSettingsProperties
- Specified by:
setTypeSettingsProperties
in interfaceLayout
-
setUserId
public void setUserId(long userId) Sets the user ID of this layout.- Specified by:
setUserId
in interfaceAuditedModel
- Specified by:
setUserId
in interfaceLayoutModel
- Parameters:
userId
- the user ID of this layout
-
setUserName
Sets the user name of this layout.- Specified by:
setUserName
in interfaceAuditedModel
- Specified by:
setUserName
in interfaceLayoutModel
- Parameters:
userName
- the user name of this layout
-
setUserUuid
Sets the user uuid of this layout.- Specified by:
setUserUuid
in interfaceAuditedModel
- Specified by:
setUserUuid
in interfaceLayoutModel
- Parameters:
userUuid
- the user uuid of this layout
-
setUuid
Sets the uuid of this layout.- Specified by:
setUuid
in interfaceLayoutModel
- Specified by:
setUuid
in interfaceStagedModel
- Parameters:
uuid
- the uuid of this layout
-
toXmlString
- Specified by:
toXmlString
in interfaceLayoutModel
-
getAttributeGetterFunctions
- Specified by:
getAttributeGetterFunctions
in interfaceBaseModel<Layout>
-
getAttributeSetterBiConsumers
- Specified by:
getAttributeSetterBiConsumers
in interfaceBaseModel<Layout>
-
getStagedModelType
- Specified by:
getStagedModelType
in interfaceStagedModel
-
wrap
- Specified by:
wrap
in classBaseModelWrapper<Layout>
-