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

public class LayoutWrapper extends BaseModelWrapper<Layout> implements Layout, ModelWrapper<Layout>

This class is a wrapper for Layout.

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • LayoutWrapper

      public LayoutWrapper(Layout layout)
  • Method Details

    • getModelAttributes

      public Map<String,Object> getModelAttributes()
      Specified by:
      getModelAttributes in interface BaseModel<Layout>
    • setModelAttributes

      public void setModelAttributes(Map<String,Object> attributes)
      Specified by:
      setModelAttributes in interface BaseModel<Layout>
    • cloneWithOriginalValues

      public Layout cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<Layout>
      Specified by:
      cloneWithOriginalValues in interface LayoutModel
    • fetchDraftLayout

      public Layout fetchDraftLayout()
      Specified by:
      fetchDraftLayout in interface Layout
    • getAllChildren

      public List<Layout> getAllChildren()
      Returns all layouts that are direct or indirect children of the current layout.
      Specified by:
      getAllChildren in interface Layout
      Returns:
      the layouts that are direct or indirect children of the current layout
    • getAncestorLayoutId

      public long getAncestorLayoutId() throws PortalException
      Returns the ID of the topmost parent layout (e.g. n-th parent layout) of the current layout.
      Specified by:
      getAncestorLayoutId in interface Layout
      Returns:
      the ID of the topmost parent layout of the current layout
      Throws:
      PortalException
    • getAncestorPlid

      public long getAncestorPlid() throws PortalException
      Returns the plid of the topmost parent layout (e.g. n-th parent layout) of the current layout.
      Specified by:
      getAncestorPlid in interface Layout
      Returns:
      the plid of the topmost parent layout of the current layout
      Throws:
      PortalException
    • getAncestors

      public List<Layout> getAncestors() throws PortalException
      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 interface Layout
      Returns:
      the current layout's list of parent layouts
      Throws:
      PortalException
    • getAvailableLanguageIds

      public String[] getAvailableLanguageIds()
      Specified by:
      getAvailableLanguageIds in interface LayoutModel
      Specified by:
      getAvailableLanguageIds in interface LocalizedModel
    • getBreadcrumb

      public String getBreadcrumb(Locale locale) throws PortalException
      Specified by:
      getBreadcrumb in interface Layout
      Throws:
      PortalException
    • getChildren

      public List<Layout> getChildren()
      Returns all child layouts of the current layout, independent of user access permissions.
      Specified by:
      getChildren in interface Layout
      Returns:
      the list of all child layouts
    • getChildren

      public List<Layout> getChildren(PermissionChecker permissionChecker) throws PortalException
      Returns all child layouts of the current layout that the user has permission to access.
      Specified by:
      getChildren in interface Layout
      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

      public String getClassName()
      Returns the fully qualified class name of this layout.
      Specified by:
      getClassName in interface LayoutModel
      Specified by:
      getClassName in interface TypedModel
      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 interface LayoutModel
      Specified by:
      getClassNameId in interface TypedModel
      Returns:
      the class name ID of this layout
    • getClassPK

      public long getClassPK()
      Returns the class pk of this layout.
      Specified by:
      getClassPK in interface AttachedModel
      Specified by:
      getClassPK in interface LayoutModel
      Returns:
      the class pk of this layout
    • getColorScheme

      public ColorScheme getColorScheme() throws PortalException
      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 interface 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
      Throws:
      PortalException
    • getColorSchemeId

      public String getColorSchemeId()
      Returns the color scheme ID of this layout.
      Specified by:
      getColorSchemeId in interface LayoutModel
      Returns:
      the color scheme ID of this layout
    • getCompanyId

      public long getCompanyId()
      Returns the company ID of this layout.
      Specified by:
      getCompanyId in interface AuditedModel
      Specified by:
      getCompanyId in interface LayoutModel
      Specified by:
      getCompanyId in interface ShardedModel
      Specified by:
      getCompanyId in interface StagedModel
      Returns:
      the company ID of this layout
    • getCreateDate

      public Date getCreateDate()
      Returns the create date of this layout.
      Specified by:
      getCreateDate in interface AuditedModel
      Specified by:
      getCreateDate in interface LayoutModel
      Specified by:
      getCreateDate in interface StagedModel
      Returns:
      the create date of this layout
    • getCss

      public String getCss()
      Returns the css of this layout.
      Specified by:
      getCss in interface LayoutModel
      Returns:
      the css of this layout
    • getCssText

      public String getCssText() throws PortalException
      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 interface Layout
      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 interface CTModel<Layout>
      Specified by:
      getCtCollectionId in interface LayoutModel
      Returns:
      the ct collection ID of this layout
    • getDefaultLanguageId

      public String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface LayoutModel
      Specified by:
      getDefaultLanguageId in interface LocalizedModel
    • getDefaultThemeSetting

      public String getDefaultThemeSetting(String key, String device, boolean inheritLookAndFeel)
      Specified by:
      getDefaultThemeSetting in interface Layout
    • getDescription

      public String getDescription()
      Returns the description of this layout.
      Specified by:
      getDescription in interface LayoutModel
      Returns:
      the description of this layout
    • getDescription

      public String getDescription(Locale locale)
      Returns the localized description of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getDescription in interface LayoutModel
      Parameters:
      locale - the locale of the language
      Returns:
      the localized description of this layout
    • getDescription

      public String getDescription(Locale locale, boolean useDefault)
      Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getDescription in interface LayoutModel
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getDescription

      public String getDescription(String languageId)
      Returns the localized description of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getDescription in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized description of this layout
    • getDescription

      public String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getDescription in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this layout
    • getDescriptionCurrentLanguageId

      public String getDescriptionCurrentLanguageId()
      Specified by:
      getDescriptionCurrentLanguageId in interface LayoutModel
    • getDescriptionCurrentValue

      public String getDescriptionCurrentValue()
      Specified by:
      getDescriptionCurrentValue in interface LayoutModel
    • getDescriptionMap

      public Map<Locale,String> getDescriptionMap()
      Returns a map of the locales and localized descriptions of this layout.
      Specified by:
      getDescriptionMap in interface LayoutModel
      Returns:
      the locales and localized descriptions of this layout
    • getEmbeddedPortlets

      public List<Portlet> getEmbeddedPortlets()
      Specified by:
      getEmbeddedPortlets in interface Layout
    • getEmbeddedPortlets

      public List<Portlet> getEmbeddedPortlets(long groupId)
      Specified by:
      getEmbeddedPortlets in interface Layout
    • getExternalReferenceCode

      public String getExternalReferenceCode()
      Returns the external reference code of this layout.
      Specified by:
      getExternalReferenceCode in interface ExternalReferenceCodeModel
      Specified by:
      getExternalReferenceCode in interface LayoutModel
      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 interface LayoutModel
      Returns:
      the favicon file entry ID of this layout
    • getFaviconURL

      public String getFaviconURL()
      Specified by:
      getFaviconURL in interface Layout
    • getFriendlyURL

      public String getFriendlyURL()
      Returns the friendly url of this layout.
      Specified by:
      getFriendlyURL in interface LayoutModel
      Returns:
      the friendly url of this layout
    • getFriendlyURL

      public String getFriendlyURL(Locale locale)
      Returns the layout's friendly URL for the given locale.
      Specified by:
      getFriendlyURL in interface Layout
      Parameters:
      locale - the locale that the friendly URL should be retrieved for
      Returns:
      the layout's friendly URL for the given locale
    • getFriendlyURLMap

      public Map<Locale,String> getFriendlyURLMap()
      Returns the friendly URLs for all configured locales.
      Specified by:
      getFriendlyURLMap in interface Layout
      Returns:
      the friendly URLs for all configured locales
    • getFriendlyURLsXML

      public String getFriendlyURLsXML()
      Specified by:
      getFriendlyURLsXML in interface Layout
    • getGroup

      public Group getGroup()
      Returns the current layout's group.

      Group is Liferay's technical name for a site.

      Specified by:
      getGroup in interface Layout
      Returns:
      the current layout's group
    • getGroupId

      public long getGroupId()
      Returns the group ID of this layout.
      Specified by:
      getGroupId in interface GroupedModel
      Specified by:
      getGroupId in interface LayoutModel
      Returns:
      the group ID of this layout
    • getHidden

      public boolean getHidden()
      Returns the hidden of this layout.
      Specified by:
      getHidden in interface LayoutModel
      Returns:
      the hidden of this layout
    • getHTMLTitle

      public String 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.
      Specified by:
      getHTMLTitle in interface Layout
      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

      public String 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.
      Specified by:
      getHTMLTitle in interface Layout
      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

      public String getIcon()
      Specified by:
      getIcon in interface Layout
    • getIconImage

      public boolean getIconImage()
      Returns true if the current layout has a configured icon.
      Specified by:
      getIconImage in interface Layout
      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 interface LayoutModel
      Returns:
      the icon image ID of this layout
    • getKeywords

      public String getKeywords()
      Returns the keywords of this layout.
      Specified by:
      getKeywords in interface LayoutModel
      Returns:
      the keywords of this layout
    • getKeywords

      public String getKeywords(Locale locale)
      Returns the localized keywords of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getKeywords in interface LayoutModel
      Parameters:
      locale - the locale of the language
      Returns:
      the localized keywords of this layout
    • getKeywords

      public String getKeywords(Locale locale, boolean useDefault)
      Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getKeywords in interface LayoutModel
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized keywords of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getKeywords

      public String getKeywords(String languageId)
      Returns the localized keywords of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getKeywords in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized keywords of this layout
    • getKeywords

      public String getKeywords(String languageId, boolean useDefault)
      Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getKeywords in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized keywords of this layout
    • getKeywordsCurrentLanguageId

      public String getKeywordsCurrentLanguageId()
      Specified by:
      getKeywordsCurrentLanguageId in interface LayoutModel
    • getKeywordsCurrentValue

      public String getKeywordsCurrentValue()
      Specified by:
      getKeywordsCurrentValue in interface LayoutModel
    • getKeywordsMap

      public Map<Locale,String> getKeywordsMap()
      Returns a map of the locales and localized keywordses of this layout.
      Specified by:
      getKeywordsMap in interface LayoutModel
      Returns:
      the locales and localized keywordses of this layout
    • getLastPublishDate

      public Date getLastPublishDate()
      Returns the last publish date of this layout.
      Specified by:
      getLastPublishDate in interface LayoutModel
      Specified by:
      getLastPublishDate in interface StagedGroupedModel
      Returns:
      the last publish date of this layout
    • getLayoutId

      public long getLayoutId()
      Returns the layout ID of this layout.
      Specified by:
      getLayoutId in interface LayoutModel
      Returns:
      the layout ID of this layout
    • getLayoutPrototypeLinkEnabled

      public boolean getLayoutPrototypeLinkEnabled()
      Returns the layout prototype link enabled of this layout.
      Specified by:
      getLayoutPrototypeLinkEnabled in interface LayoutModel
      Returns:
      the layout prototype link enabled of this layout
    • getLayoutPrototypeUuid

      public String getLayoutPrototypeUuid()
      Returns the layout prototype uuid of this layout.
      Specified by:
      getLayoutPrototypeUuid in interface LayoutModel
      Returns:
      the layout prototype uuid of this layout
    • getLayoutSet

      public LayoutSet getLayoutSet()
      Returns the current layout's LayoutSet.
      Specified by:
      getLayoutSet in interface Layout
      Returns:
      the current layout's layout set
    • getLayoutSetPrototypeLayout

      public Layout getLayoutSetPrototypeLayout()
      Specified by:
      getLayoutSetPrototypeLayout in interface Layout
    • getLayoutType

      public LayoutType getLayoutType()
      Returns the current layout's LayoutType.
      Specified by:
      getLayoutType in interface Layout
      Returns:
      the current layout's layout type
    • getLinkedToLayout

      public Layout getLinkedToLayout()
      Returns the current layout's linked layout.
      Specified by:
      getLinkedToLayout in interface Layout
      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 interface LayoutModel
      Returns:
      the master layout plid of this layout
    • getModifiedDate

      public Date getModifiedDate()
      Returns the modified date of this layout.
      Specified by:
      getModifiedDate in interface AuditedModel
      Specified by:
      getModifiedDate in interface LayoutModel
      Specified by:
      getModifiedDate in interface StagedModel
      Returns:
      the modified date of this layout
    • getMvccVersion

      public long getMvccVersion()
      Returns the mvcc version of this layout.
      Specified by:
      getMvccVersion in interface LayoutModel
      Specified by:
      getMvccVersion in interface MVCCModel
      Returns:
      the mvcc version of this layout
    • getName

      public String getName()
      Returns the name of this layout.
      Specified by:
      getName in interface LayoutModel
      Returns:
      the name of this layout
    • getName

      public String getName(Locale locale)
      Returns the localized name of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getName in interface LayoutModel
      Parameters:
      locale - the locale of the language
      Returns:
      the localized name of this layout
    • getName

      public String getName(Locale locale, boolean useDefault)
      Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getName in interface LayoutModel
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized name of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getName

      public String getName(String languageId)
      Returns the localized name of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getName in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized name of this layout
    • getName

      public String getName(String languageId, boolean useDefault)
      Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getName in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized name of this layout
    • getNameCurrentLanguageId

      public String getNameCurrentLanguageId()
      Specified by:
      getNameCurrentLanguageId in interface LayoutModel
    • getNameCurrentValue

      public String getNameCurrentValue()
      Specified by:
      getNameCurrentValue in interface LayoutModel
    • getNameMap

      public Map<Locale,String> getNameMap()
      Returns a map of the locales and localized names of this layout.
      Specified by:
      getNameMap in interface LayoutModel
      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 interface LayoutModel
      Returns:
      the parent layout ID of this layout
    • getParentPlid

      public long getParentPlid()
      Returns the parent plid of this layout.
      Specified by:
      getParentPlid in interface LayoutModel
      Returns:
      the parent plid of this layout
    • getPlid

      public long getPlid()
      Returns the plid of this layout.
      Specified by:
      getPlid in interface LayoutModel
      Returns:
      the plid of this layout
    • getPrimaryKey

      public long getPrimaryKey()
      Returns the primary key of this layout.
      Specified by:
      getPrimaryKey in interface CTModel<Layout>
      Specified by:
      getPrimaryKey in interface LayoutModel
      Returns:
      the primary key of this layout
    • getPriority

      public int getPriority()
      Returns the priority of this layout.
      Specified by:
      getPriority in interface LayoutModel
      Returns:
      the priority of this layout
    • getPrivateLayout

      public boolean getPrivateLayout()
      Returns the private layout of this layout.
      Specified by:
      getPrivateLayout in interface LayoutModel
      Returns:
      the private layout of this layout
    • getPublishDate

      public Date getPublishDate()
      Returns the publish date of this layout.
      Specified by:
      getPublishDate in interface LayoutModel
      Returns:
      the publish date of this layout
    • getRegularURL

      public String getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Specified by:
      getRegularURL in interface Layout
      Throws:
      PortalException
    • getResetLayoutURL

      public String getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Specified by:
      getResetLayoutURL in interface Layout
      Throws:
      PortalException
    • getResetMaxStateURL

      public String getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Specified by:
      getResetMaxStateURL in interface Layout
      Throws:
      PortalException
    • getRobots

      public String getRobots()
      Returns the robots of this layout.
      Specified by:
      getRobots in interface LayoutModel
      Returns:
      the robots of this layout
    • getRobots

      public String getRobots(Locale locale)
      Returns the localized robots of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getRobots in interface LayoutModel
      Parameters:
      locale - the locale of the language
      Returns:
      the localized robots of this layout
    • getRobots

      public String getRobots(Locale locale, boolean useDefault)
      Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getRobots in interface LayoutModel
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized robots of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getRobots

      public String getRobots(String languageId)
      Returns the localized robots of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getRobots in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized robots of this layout
    • getRobots

      public String getRobots(String languageId, boolean useDefault)
      Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getRobots in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized robots of this layout
    • getRobotsCurrentLanguageId

      public String getRobotsCurrentLanguageId()
      Specified by:
      getRobotsCurrentLanguageId in interface LayoutModel
    • getRobotsCurrentValue

      public String getRobotsCurrentValue()
      Specified by:
      getRobotsCurrentValue in interface LayoutModel
    • getRobotsMap

      public Map<Locale,String> getRobotsMap()
      Returns a map of the locales and localized robotses of this layout.
      Specified by:
      getRobotsMap in interface LayoutModel
      Returns:
      the locales and localized robotses of this layout
    • getScopeGroup

      public Group getScopeGroup() throws PortalException
      Specified by:
      getScopeGroup in interface Layout
      Throws:
      PortalException
    • getSourcePrototypeLayoutUuid

      public String getSourcePrototypeLayoutUuid()
      Returns the source prototype layout uuid of this layout.
      Specified by:
      getSourcePrototypeLayoutUuid in interface LayoutModel
      Returns:
      the source prototype layout uuid of this layout
    • getStatus

      public int getStatus()
      Returns the status of this layout.
      Specified by:
      getStatus in interface LayoutModel
      Specified by:
      getStatus in interface WorkflowedModel
      Returns:
      the status of this layout
    • getStatusByUserId

      public long getStatusByUserId()
      Returns the status by user ID of this layout.
      Specified by:
      getStatusByUserId in interface LayoutModel
      Specified by:
      getStatusByUserId in interface WorkflowedModel
      Returns:
      the status by user ID of this layout
    • getStatusByUserName

      public String getStatusByUserName()
      Returns the status by user name of this layout.
      Specified by:
      getStatusByUserName in interface LayoutModel
      Specified by:
      getStatusByUserName in interface WorkflowedModel
      Returns:
      the status by user name of this layout
    • getStatusByUserUuid

      public String getStatusByUserUuid()
      Returns the status by user uuid of this layout.
      Specified by:
      getStatusByUserUuid in interface LayoutModel
      Specified by:
      getStatusByUserUuid in interface WorkflowedModel
      Returns:
      the status by user uuid of this layout
    • getStatusDate

      public Date getStatusDate()
      Returns the status date of this layout.
      Specified by:
      getStatusDate in interface LayoutModel
      Specified by:
      getStatusDate in interface WorkflowedModel
      Returns:
      the status date of this layout
    • getStyleBookEntryId

      public long getStyleBookEntryId()
      Returns the style book entry ID of this layout.
      Specified by:
      getStyleBookEntryId in interface LayoutModel
      Returns:
      the style book entry ID of this layout
    • getSystem

      public boolean getSystem()
      Returns the system of this layout.
      Specified by:
      getSystem in interface LayoutModel
      Returns:
      the system of this layout
    • getTarget

      public String getTarget()
      Specified by:
      getTarget in interface Layout
    • getTheme

      public Theme getTheme() throws PortalException
      Returns the current layout's theme, or the layout set's theme if no layout theme is configured.
      Specified by:
      getTheme in interface Layout
      Returns:
      the current layout's theme, or the layout set's theme if no layout theme is configured
      Throws:
      PortalException
    • getThemeId

      public String getThemeId()
      Returns the theme ID of this layout.
      Specified by:
      getThemeId in interface LayoutModel
      Returns:
      the theme ID of this layout
    • getThemeSetting

      public String getThemeSetting(String key, String device)
      Specified by:
      getThemeSetting in interface Layout
    • getThemeSetting

      public String getThemeSetting(String key, String device, boolean inheritLookAndFeel)
      Specified by:
      getThemeSetting in interface Layout
    • getTitle

      public String getTitle()
      Returns the title of this layout.
      Specified by:
      getTitle in interface LayoutModel
      Returns:
      the title of this layout
    • getTitle

      public String getTitle(Locale locale)
      Returns the localized title of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getTitle in interface LayoutModel
      Parameters:
      locale - the locale of the language
      Returns:
      the localized title of this layout
    • getTitle

      public String getTitle(Locale locale, boolean useDefault)
      Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getTitle in interface LayoutModel
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized title of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getTitle

      public String getTitle(String languageId)
      Returns the localized title of this layout in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getTitle in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized title of this layout
    • getTitle

      public String getTitle(String languageId, boolean useDefault)
      Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
      Specified by:
      getTitle in interface LayoutModel
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized title of this layout
    • getTitleCurrentLanguageId

      public String getTitleCurrentLanguageId()
      Specified by:
      getTitleCurrentLanguageId in interface LayoutModel
    • getTitleCurrentValue

      public String getTitleCurrentValue()
      Specified by:
      getTitleCurrentValue in interface LayoutModel
    • getTitleMap

      public Map<Locale,String> getTitleMap()
      Returns a map of the locales and localized titles of this layout.
      Specified by:
      getTitleMap in interface LayoutModel
      Returns:
      the locales and localized titles of this layout
    • getType

      public String getType()
      Returns the type of this layout.
      Specified by:
      getType in interface LayoutModel
      Returns:
      the type of this layout
    • getTypeSettings

      public String getTypeSettings()
      Returns the type settings of this layout.
      Specified by:
      getTypeSettings in interface LayoutModel
      Returns:
      the type settings of this layout
    • getTypeSettingsProperties

      public UnicodeProperties getTypeSettingsProperties()
      Specified by:
      getTypeSettingsProperties in interface Layout
    • getTypeSettingsProperty

      public String getTypeSettingsProperty(String key)
      Specified by:
      getTypeSettingsProperty in interface Layout
    • getTypeSettingsProperty

      public String getTypeSettingsProperty(String key, String defaultValue)
      Specified by:
      getTypeSettingsProperty in interface Layout
    • getUserId

      public long getUserId()
      Returns the user ID of this layout.
      Specified by:
      getUserId in interface AuditedModel
      Specified by:
      getUserId in interface LayoutModel
      Returns:
      the user ID of this layout
    • getUserName

      public String getUserName()
      Returns the user name of this layout.
      Specified by:
      getUserName in interface AuditedModel
      Specified by:
      getUserName in interface LayoutModel
      Returns:
      the user name of this layout
    • getUserUuid

      public String getUserUuid()
      Returns the user uuid of this layout.
      Specified by:
      getUserUuid in interface AuditedModel
      Specified by:
      getUserUuid in interface LayoutModel
      Returns:
      the user uuid of this layout
    • getUuid

      public String getUuid()
      Returns the uuid of this layout.
      Specified by:
      getUuid in interface LayoutModel
      Specified by:
      getUuid in interface StagedModel
      Returns:
      the uuid of this layout
    • hasAncestor

      public boolean hasAncestor(long layoutId) throws PortalException
      Returns true if the given layout ID matches one of the current layout's hierarchical parents.
      Specified by:
      hasAncestor in interface Layout
      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()
      Returns true if the current layout has child layouts.
      Specified by:
      hasChildren in interface Layout
      Returns:
      true if the current layout has child layouts, false otherwise
    • hasScopeGroup

      public boolean hasScopeGroup() throws PortalException
      Specified by:
      hasScopeGroup in interface Layout
      Throws:
      PortalException
    • hasSetModifiedDate

      public boolean hasSetModifiedDate()
      Specified by:
      hasSetModifiedDate in interface Layout
    • includeLayoutContent

      public boolean includeLayoutContent(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws Exception
      Specified by:
      includeLayoutContent in interface Layout
      Throws:
      Exception
    • isApproved

      public boolean isApproved()
      Returns true if this layout is approved.
      Specified by:
      isApproved in interface LayoutModel
      Specified by:
      isApproved in interface WorkflowedModel
      Returns:
      true if this layout is approved; false otherwise
    • isChildSelected

      public boolean isChildSelected(boolean selectable, Layout layout) throws PortalException
      Specified by:
      isChildSelected in interface Layout
      Throws:
      PortalException
    • isContentDisplayPage

      public boolean isContentDisplayPage()
      Returns true 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 interface Layout
      Returns:
      true if the current layout can be used as a content display page; false otherwise
    • isCustomizable

      public boolean isCustomizable()
      Specified by:
      isCustomizable in interface Layout
    • isDenied

      public boolean isDenied()
      Returns true if this layout is denied.
      Specified by:
      isDenied in interface LayoutModel
      Specified by:
      isDenied in interface WorkflowedModel
      Returns:
      true if this layout is denied; false otherwise
    • isDraft

      public boolean isDraft()
      Returns true if this layout is a draft.
      Specified by:
      isDraft in interface LayoutModel
      Specified by:
      isDraft in interface WorkflowedModel
      Returns:
      true if this layout is a draft; false otherwise
    • isDraftLayout

      public boolean isDraftLayout()
      Specified by:
      isDraftLayout in interface Layout
    • isEmbeddedPersonalApplication

      public boolean isEmbeddedPersonalApplication()
      Specified by:
      isEmbeddedPersonalApplication in interface Layout
    • isExpired

      public boolean isExpired()
      Returns true if this layout is expired.
      Specified by:
      isExpired in interface LayoutModel
      Specified by:
      isExpired in interface WorkflowedModel
      Returns:
      true if this layout is expired; false otherwise
    • isFirstChild

      public boolean isFirstChild()
      Returns true if the current layout is the first layout in its parent's hierarchical list of children layouts.
      Specified by:
      isFirstChild in interface Layout
      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()
      Returns true if the current layout is the topmost parent layout.
      Specified by:
      isFirstParent in interface Layout
      Returns:
      true if the current layout is the topmost parent layout; false otherwise
    • isHidden

      public boolean isHidden()
      Returns true if this layout is hidden.
      Specified by:
      isHidden in interface LayoutModel
      Returns:
      true if this layout is hidden; false otherwise
    • isIconImage

      public boolean isIconImage()
      Specified by:
      isIconImage in interface Layout
    • isInactive

      public boolean isInactive()
      Returns true if this layout is inactive.
      Specified by:
      isInactive in interface LayoutModel
      Specified by:
      isInactive in interface WorkflowedModel
      Returns:
      true if this layout is inactive; false otherwise
    • isIncomplete

      public boolean isIncomplete()
      Returns true if this layout is incomplete.
      Specified by:
      isIncomplete in interface LayoutModel
      Specified by:
      isIncomplete in interface WorkflowedModel
      Returns:
      true if this layout is incomplete; false otherwise
    • isInheritLookAndFeel

      public boolean isInheritLookAndFeel()
      Returns true if the current layout utilizes its LayoutSet's look and feel options (e.g. theme and color scheme).
      Specified by:
      isInheritLookAndFeel in interface Layout
      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 interface Layout
    • isLayoutPrototypeLinkActive

      public boolean isLayoutPrototypeLinkActive()
      Returns true if the current layout is built from a layout template and still maintains an active connection to it.
      Specified by:
      isLayoutPrototypeLinkActive in interface Layout
      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()
      Returns true if this layout is layout prototype link enabled.
      Specified by:
      isLayoutPrototypeLinkEnabled in interface LayoutModel
      Returns:
      true if this layout is layout prototype link enabled; false otherwise
    • isLayoutSortable

      public boolean isLayoutSortable()
      Specified by:
      isLayoutSortable in interface Layout
    • isLayoutUpdateable

      public boolean isLayoutUpdateable()
      Specified by:
      isLayoutUpdateable in interface Layout
    • isPending

      public boolean isPending()
      Returns true if this layout is pending.
      Specified by:
      isPending in interface LayoutModel
      Specified by:
      isPending in interface WorkflowedModel
      Returns:
      true if this layout is pending; false otherwise
    • isPortletEmbedded

      public boolean isPortletEmbedded(String portletId, long groupId)
      Specified by:
      isPortletEmbedded in interface Layout
    • isPrivateLayout

      public boolean isPrivateLayout()
      Returns true if this layout is private layout.
      Specified by:
      isPrivateLayout in interface LayoutModel
      Returns:
      true if this layout is private layout; false otherwise
    • isPublicLayout

      public boolean isPublicLayout()
      Returns true if the current layout is part of the public LayoutSet.

      Note, the returned value reflects the layout's default access options, not its access permissions.

      Specified by:
      isPublicLayout in interface Layout
      Returns:
      true if the current layout is part of the public layout set; false otherwise
    • isPublished

      public boolean isPublished()
      Specified by:
      isPublished in interface Layout
    • isRootLayout

      public boolean isRootLayout()
      Returns true if the current layout is the root layout.
      Specified by:
      isRootLayout in interface Layout
      Returns:
      true if the current layout is the root layout; false otherwise
    • isScheduled

      public boolean isScheduled()
      Returns true if this layout is scheduled.
      Specified by:
      isScheduled in interface LayoutModel
      Specified by:
      isScheduled in interface WorkflowedModel
      Returns:
      true if this layout is scheduled; false otherwise
    • isSelected

      public boolean isSelected(boolean selectable, Layout layout, long ancestorPlid)
      Specified by:
      isSelected in interface Layout
    • isSupportsEmbeddedPortlets

      public boolean isSupportsEmbeddedPortlets()
      Returns true if the current layout can hold embedded portlets.
      Specified by:
      isSupportsEmbeddedPortlets in interface Layout
      Returns:
      true if the current layout can hold embedded portlets; false otherwise
    • isSystem

      public boolean isSystem()
      Returns true if this layout is system.
      Specified by:
      isSystem in interface LayoutModel
      Returns:
      true if this layout is system; false otherwise
    • isTypeAssetDisplay

      public boolean isTypeAssetDisplay()
      Specified by:
      isTypeAssetDisplay in interface Layout
    • isTypeContent

      public boolean isTypeContent()
      Specified by:
      isTypeContent in interface Layout
    • isTypeControlPanel

      public boolean isTypeControlPanel()
      Specified by:
      isTypeControlPanel in interface Layout
    • isTypeEmbedded

      public boolean isTypeEmbedded()
      Specified by:
      isTypeEmbedded in interface Layout
    • isTypeLinkToLayout

      public boolean isTypeLinkToLayout()
      Specified by:
      isTypeLinkToLayout in interface Layout
    • isTypePanel

      public boolean isTypePanel()
      Specified by:
      isTypePanel in interface Layout
    • isTypePortlet

      public boolean isTypePortlet()
      Specified by:
      isTypePortlet in interface Layout
    • isTypeURL

      public boolean isTypeURL()
      Specified by:
      isTypeURL in interface Layout
    • isTypeUtility

      public boolean isTypeUtility()
      Specified by:
      isTypeUtility in interface Layout
    • isUnlocked

      public boolean isUnlocked(String mode, long userId)
      Specified by:
      isUnlocked in interface Layout
    • matches

      public boolean matches(javax.servlet.http.HttpServletRequest httpServletRequest, String friendlyURL)
      Specified by:
      matches in interface Layout
    • 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 interface PersistedModel
    • prepareLocalizedFieldsForImport

      public void prepareLocalizedFieldsForImport() throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LayoutModel
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • prepareLocalizedFieldsForImport

      public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LayoutModel
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • setClassName

      public void setClassName(String className)
      Specified by:
      setClassName in interface LayoutModel
    • setClassNameId

      public void setClassNameId(long classNameId)
      Sets the class name ID of this layout.
      Specified by:
      setClassNameId in interface LayoutModel
      Specified by:
      setClassNameId in interface TypedModel
      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 interface AttachedModel
      Specified by:
      setClassPK in interface LayoutModel
      Parameters:
      classPK - the class pk of this layout
    • setColorSchemeId

      public void setColorSchemeId(String colorSchemeId)
      Sets the color scheme ID of this layout.
      Specified by:
      setColorSchemeId in interface LayoutModel
      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 interface AuditedModel
      Specified by:
      setCompanyId in interface LayoutModel
      Specified by:
      setCompanyId in interface ShardedModel
      Specified by:
      setCompanyId in interface StagedModel
      Parameters:
      companyId - the company ID of this layout
    • setCreateDate

      public void setCreateDate(Date createDate)
      Sets the create date of this layout.
      Specified by:
      setCreateDate in interface AuditedModel
      Specified by:
      setCreateDate in interface LayoutModel
      Specified by:
      setCreateDate in interface StagedModel
      Parameters:
      createDate - the create date of this layout
    • setCss

      public void setCss(String css)
      Sets the css of this layout.
      Specified by:
      setCss in interface LayoutModel
      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 interface CTModel<Layout>
      Specified by:
      setCtCollectionId in interface LayoutModel
      Parameters:
      ctCollectionId - the ct collection ID of this layout
    • setDescription

      public void setDescription(String description)
      Sets the description of this layout.
      Specified by:
      setDescription in interface LayoutModel
      Parameters:
      description - the description of this layout
    • setDescription

      public void setDescription(String description, Locale locale)
      Sets the localized description of this layout in the language.
      Specified by:
      setDescription in interface LayoutModel
      Parameters:
      description - the localized description of this layout
      locale - the locale of the language
    • setDescription

      public void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this layout in the language, and sets the default locale.
      Specified by:
      setDescription in interface LayoutModel
      Parameters:
      description - the localized description of this layout
      locale - the locale of the language
      defaultLocale - the default locale
    • setDescriptionCurrentLanguageId

      public void setDescriptionCurrentLanguageId(String languageId)
      Specified by:
      setDescriptionCurrentLanguageId in interface LayoutModel
    • setDescriptionMap

      public void setDescriptionMap(Map<Locale,String> descriptionMap)
      Sets the localized descriptions of this layout from the map of locales and localized descriptions.
      Specified by:
      setDescriptionMap in interface LayoutModel
      Parameters:
      descriptionMap - the locales and localized descriptions of this layout
    • setDescriptionMap

      public 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.
      Specified by:
      setDescriptionMap in interface LayoutModel
      Parameters:
      descriptionMap - the locales and localized descriptions of this layout
      defaultLocale - the default locale
    • setExternalReferenceCode

      public void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this layout.
      Specified by:
      setExternalReferenceCode in interface ExternalReferenceCodeModel
      Specified by:
      setExternalReferenceCode in interface LayoutModel
      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 interface LayoutModel
      Parameters:
      faviconFileEntryId - the favicon file entry ID of this layout
    • setFriendlyURL

      public void setFriendlyURL(String friendlyURL)
      Sets the friendly url of this layout.
      Specified by:
      setFriendlyURL in interface LayoutModel
      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 interface GroupedModel
      Specified by:
      setGroupId in interface LayoutModel
      Parameters:
      groupId - the group ID of this layout
    • setHidden

      public void setHidden(boolean hidden)
      Sets whether this layout is hidden.
      Specified by:
      setHidden in interface LayoutModel
      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 interface LayoutModel
      Parameters:
      iconImageId - the icon image ID of this layout
    • setKeywords

      public void setKeywords(String keywords)
      Sets the keywords of this layout.
      Specified by:
      setKeywords in interface LayoutModel
      Parameters:
      keywords - the keywords of this layout
    • setKeywords

      public void setKeywords(String keywords, Locale locale)
      Sets the localized keywords of this layout in the language.
      Specified by:
      setKeywords in interface LayoutModel
      Parameters:
      keywords - the localized keywords of this layout
      locale - the locale of the language
    • setKeywords

      public void setKeywords(String keywords, Locale locale, Locale defaultLocale)
      Sets the localized keywords of this layout in the language, and sets the default locale.
      Specified by:
      setKeywords in interface LayoutModel
      Parameters:
      keywords - the localized keywords of this layout
      locale - the locale of the language
      defaultLocale - the default locale
    • setKeywordsCurrentLanguageId

      public void setKeywordsCurrentLanguageId(String languageId)
      Specified by:
      setKeywordsCurrentLanguageId in interface LayoutModel
    • setKeywordsMap

      public void setKeywordsMap(Map<Locale,String> keywordsMap)
      Sets the localized keywordses of this layout from the map of locales and localized keywordses.
      Specified by:
      setKeywordsMap in interface LayoutModel
      Parameters:
      keywordsMap - the locales and localized keywordses of this layout
    • setKeywordsMap

      public 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.
      Specified by:
      setKeywordsMap in interface LayoutModel
      Parameters:
      keywordsMap - the locales and localized keywordses of this layout
      defaultLocale - the default locale
    • setLastPublishDate

      public void setLastPublishDate(Date lastPublishDate)
      Sets the last publish date of this layout.
      Specified by:
      setLastPublishDate in interface LayoutModel
      Specified by:
      setLastPublishDate in interface StagedGroupedModel
      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 interface LayoutModel
      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 interface LayoutModel
      Parameters:
      layoutPrototypeLinkEnabled - the layout prototype link enabled of this layout
    • setLayoutPrototypeUuid

      public void setLayoutPrototypeUuid(String layoutPrototypeUuid)
      Sets the layout prototype uuid of this layout.
      Specified by:
      setLayoutPrototypeUuid in interface LayoutModel
      Parameters:
      layoutPrototypeUuid - the layout prototype uuid of this layout
    • setLayoutSet

      public void setLayoutSet(LayoutSet layoutSet)
      Specified by:
      setLayoutSet in interface Layout
    • setMasterLayoutPlid

      public void setMasterLayoutPlid(long masterLayoutPlid)
      Sets the master layout plid of this layout.
      Specified by:
      setMasterLayoutPlid in interface LayoutModel
      Parameters:
      masterLayoutPlid - the master layout plid of this layout
    • setModifiedDate

      public void setModifiedDate(Date modifiedDate)
      Sets the modified date of this layout.
      Specified by:
      setModifiedDate in interface AuditedModel
      Specified by:
      setModifiedDate in interface LayoutModel
      Specified by:
      setModifiedDate in interface StagedModel
      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 interface LayoutModel
      Specified by:
      setMvccVersion in interface MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this layout
    • setName

      public void setName(String name)
      Sets the name of this layout.
      Specified by:
      setName in interface LayoutModel
      Parameters:
      name - the name of this layout
    • setName

      public void setName(String name, Locale locale)
      Sets the localized name of this layout in the language.
      Specified by:
      setName in interface LayoutModel
      Parameters:
      name - the localized name of this layout
      locale - the locale of the language
    • setName

      public void setName(String name, Locale locale, Locale defaultLocale)
      Sets the localized name of this layout in the language, and sets the default locale.
      Specified by:
      setName in interface LayoutModel
      Parameters:
      name - the localized name of this layout
      locale - the locale of the language
      defaultLocale - the default locale
    • setNameCurrentLanguageId

      public void setNameCurrentLanguageId(String languageId)
      Specified by:
      setNameCurrentLanguageId in interface LayoutModel
    • setNameMap

      public void setNameMap(Map<Locale,String> nameMap)
      Sets the localized names of this layout from the map of locales and localized names.
      Specified by:
      setNameMap in interface LayoutModel
      Parameters:
      nameMap - the locales and localized names of this layout
    • setNameMap

      public 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.
      Specified by:
      setNameMap in interface LayoutModel
      Parameters:
      nameMap - the locales and localized names of this layout
      defaultLocale - the default locale
    • setParentLayoutId

      public void setParentLayoutId(long parentLayoutId)
      Sets the parent layout ID of this layout.
      Specified by:
      setParentLayoutId in interface LayoutModel
      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 interface LayoutModel
      Parameters:
      parentPlid - the parent plid of this layout
    • setPlid

      public void setPlid(long plid)
      Sets the plid of this layout.
      Specified by:
      setPlid in interface LayoutModel
      Parameters:
      plid - the plid of this layout
    • setPrimaryKey

      public void setPrimaryKey(long primaryKey)
      Sets the primary key of this layout.
      Specified by:
      setPrimaryKey in interface CTModel<Layout>
      Specified by:
      setPrimaryKey in interface LayoutModel
      Parameters:
      primaryKey - the primary key of this layout
    • setPriority

      public void setPriority(int priority)
      Sets the priority of this layout.
      Specified by:
      setPriority in interface LayoutModel
      Parameters:
      priority - the priority of this layout
    • setPrivateLayout

      public void setPrivateLayout(boolean privateLayout)
      Sets whether this layout is private layout.
      Specified by:
      setPrivateLayout in interface LayoutModel
      Parameters:
      privateLayout - the private layout of this layout
    • setPublishDate

      public void setPublishDate(Date publishDate)
      Sets the publish date of this layout.
      Specified by:
      setPublishDate in interface LayoutModel
      Parameters:
      publishDate - the publish date of this layout
    • setRobots

      public void setRobots(String robots)
      Sets the robots of this layout.
      Specified by:
      setRobots in interface LayoutModel
      Parameters:
      robots - the robots of this layout
    • setRobots

      public void setRobots(String robots, Locale locale)
      Sets the localized robots of this layout in the language.
      Specified by:
      setRobots in interface LayoutModel
      Parameters:
      robots - the localized robots of this layout
      locale - the locale of the language
    • setRobots

      public void setRobots(String robots, Locale locale, Locale defaultLocale)
      Sets the localized robots of this layout in the language, and sets the default locale.
      Specified by:
      setRobots in interface LayoutModel
      Parameters:
      robots - the localized robots of this layout
      locale - the locale of the language
      defaultLocale - the default locale
    • setRobotsCurrentLanguageId

      public void setRobotsCurrentLanguageId(String languageId)
      Specified by:
      setRobotsCurrentLanguageId in interface LayoutModel
    • setRobotsMap

      public void setRobotsMap(Map<Locale,String> robotsMap)
      Sets the localized robotses of this layout from the map of locales and localized robotses.
      Specified by:
      setRobotsMap in interface LayoutModel
      Parameters:
      robotsMap - the locales and localized robotses of this layout
    • setRobotsMap

      public 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.
      Specified by:
      setRobotsMap in interface LayoutModel
      Parameters:
      robotsMap - the locales and localized robotses of this layout
      defaultLocale - the default locale
    • setSourcePrototypeLayoutUuid

      public void setSourcePrototypeLayoutUuid(String sourcePrototypeLayoutUuid)
      Sets the source prototype layout uuid of this layout.
      Specified by:
      setSourcePrototypeLayoutUuid in interface LayoutModel
      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 interface LayoutModel
      Specified by:
      setStatus in interface WorkflowedModel
      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 interface LayoutModel
      Specified by:
      setStatusByUserId in interface WorkflowedModel
      Parameters:
      statusByUserId - the status by user ID of this layout
    • setStatusByUserName

      public void setStatusByUserName(String statusByUserName)
      Sets the status by user name of this layout.
      Specified by:
      setStatusByUserName in interface LayoutModel
      Specified by:
      setStatusByUserName in interface WorkflowedModel
      Parameters:
      statusByUserName - the status by user name of this layout
    • setStatusByUserUuid

      public void setStatusByUserUuid(String statusByUserUuid)
      Sets the status by user uuid of this layout.
      Specified by:
      setStatusByUserUuid in interface LayoutModel
      Specified by:
      setStatusByUserUuid in interface WorkflowedModel
      Parameters:
      statusByUserUuid - the status by user uuid of this layout
    • setStatusDate

      public void setStatusDate(Date statusDate)
      Sets the status date of this layout.
      Specified by:
      setStatusDate in interface LayoutModel
      Specified by:
      setStatusDate in interface WorkflowedModel
      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 interface LayoutModel
      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 interface LayoutModel
      Parameters:
      system - the system of this layout
    • setThemeId

      public void setThemeId(String themeId)
      Sets the theme ID of this layout.
      Specified by:
      setThemeId in interface LayoutModel
      Parameters:
      themeId - the theme ID of this layout
    • setTitle

      public void setTitle(String title)
      Sets the title of this layout.
      Specified by:
      setTitle in interface LayoutModel
      Parameters:
      title - the title of this layout
    • setTitle

      public void setTitle(String title, Locale locale)
      Sets the localized title of this layout in the language.
      Specified by:
      setTitle in interface LayoutModel
      Parameters:
      title - the localized title of this layout
      locale - the locale of the language
    • setTitle

      public void setTitle(String title, Locale locale, Locale defaultLocale)
      Sets the localized title of this layout in the language, and sets the default locale.
      Specified by:
      setTitle in interface LayoutModel
      Parameters:
      title - the localized title of this layout
      locale - the locale of the language
      defaultLocale - the default locale
    • setTitleCurrentLanguageId

      public void setTitleCurrentLanguageId(String languageId)
      Specified by:
      setTitleCurrentLanguageId in interface LayoutModel
    • setTitleMap

      public void setTitleMap(Map<Locale,String> titleMap)
      Sets the localized titles of this layout from the map of locales and localized titles.
      Specified by:
      setTitleMap in interface LayoutModel
      Parameters:
      titleMap - the locales and localized titles of this layout
    • setTitleMap

      public 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.
      Specified by:
      setTitleMap in interface LayoutModel
      Parameters:
      titleMap - the locales and localized titles of this layout
      defaultLocale - the default locale
    • setType

      public void setType(String type)
      Sets the type of this layout.
      Specified by:
      setType in interface LayoutModel
      Parameters:
      type - the type of this layout
    • setTypeSettings

      public void setTypeSettings(String typeSettings)
      Sets the type settings of this layout.
      Specified by:
      setTypeSettings in interface LayoutModel
      Parameters:
      typeSettings - the type settings of this layout
    • setTypeSettingsProperties

      public void setTypeSettingsProperties(UnicodeProperties typeSettingsUnicodeProperties)
      Specified by:
      setTypeSettingsProperties in interface Layout
    • setUserId

      public void setUserId(long userId)
      Sets the user ID of this layout.
      Specified by:
      setUserId in interface AuditedModel
      Specified by:
      setUserId in interface LayoutModel
      Parameters:
      userId - the user ID of this layout
    • setUserName

      public void setUserName(String userName)
      Sets the user name of this layout.
      Specified by:
      setUserName in interface AuditedModel
      Specified by:
      setUserName in interface LayoutModel
      Parameters:
      userName - the user name of this layout
    • setUserUuid

      public void setUserUuid(String userUuid)
      Sets the user uuid of this layout.
      Specified by:
      setUserUuid in interface AuditedModel
      Specified by:
      setUserUuid in interface LayoutModel
      Parameters:
      userUuid - the user uuid of this layout
    • setUuid

      public void setUuid(String uuid)
      Sets the uuid of this layout.
      Specified by:
      setUuid in interface LayoutModel
      Specified by:
      setUuid in interface StagedModel
      Parameters:
      uuid - the uuid of this layout
    • toXmlString

      public String toXmlString()
      Specified by:
      toXmlString in interface LayoutModel
    • getAttributeGetterFunctions

      public Map<String,Function<Layout,Object>> getAttributeGetterFunctions()
      Specified by:
      getAttributeGetterFunctions in interface BaseModel<Layout>
    • getAttributeSetterBiConsumers

      public Map<String,BiConsumer<Layout,Object>> getAttributeSetterBiConsumers()
      Specified by:
      getAttributeSetterBiConsumers in interface BaseModel<Layout>
    • getStagedModelType

      public StagedModelType getStagedModelType()
      Specified by:
      getStagedModelType in interface StagedModel
    • wrap

      protected LayoutWrapper wrap(Layout layout)
      Specified by:
      wrap in class BaseModelWrapper<Layout>