Class LayoutSetWrapper

Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<LayoutSet>
com.liferay.portal.kernel.model.LayoutSetWrapper
All Implemented Interfaces:
BaseModel<LayoutSet>, CTModel<LayoutSet>, ClassedModel, LayoutSet, LayoutSetModel, ModelWrapper<LayoutSet>, MVCCModel, PersistedModel, ShardedModel, Serializable, Cloneable, Comparable<LayoutSet>

public class LayoutSetWrapper extends BaseModelWrapper<LayoutSet> implements LayoutSet, ModelWrapper<LayoutSet>

This class is a wrapper for LayoutSet.

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

    • LayoutSetWrapper

      public LayoutSetWrapper(LayoutSet layoutSet)
  • Method Details

    • getModelAttributes

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

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

      public LayoutSet cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<LayoutSet>
      Specified by:
      cloneWithOriginalValues in interface LayoutSetModel
    • getColorScheme

      public ColorScheme getColorScheme()
      Returns the layout set's color scheme.

      Just like themes, color schemes can be configured on the layout set level. The layout set's color scheme can be overridden on the layout level.

      Specified by:
      getColorScheme in interface LayoutSet
      Returns:
      the layout set's color scheme
    • getColorSchemeId

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

      public String getCompanyFallbackVirtualHostname()
      Specified by:
      getCompanyFallbackVirtualHostname in interface LayoutSet
    • getCompanyId

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

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

      public String getCss()
      Returns the css of this layout set.
      Specified by:
      getCss in interface LayoutSetModel
      Returns:
      the css of this layout set
    • getCtCollectionId

      public long getCtCollectionId()
      Returns the ct collection ID of this layout set.
      Specified by:
      getCtCollectionId in interface CTModel<LayoutSet>
      Specified by:
      getCtCollectionId in interface LayoutSetModel
      Returns:
      the ct collection ID of this layout set
    • getFaviconFileEntryId

      public long getFaviconFileEntryId()
      Returns the favicon file entry ID of this layout set.
      Specified by:
      getFaviconFileEntryId in interface LayoutSetModel
      Returns:
      the favicon file entry ID of this layout set
    • getFaviconURL

      public String getFaviconURL()
      Specified by:
      getFaviconURL in interface LayoutSet
    • getGroup

      public Group getGroup() throws PortalException
      Returns the layout set's group.
      Specified by:
      getGroup in interface LayoutSet
      Returns:
      the layout set's group
      Throws:
      PortalException
    • getGroupId

      public long getGroupId()
      Returns the group ID of this layout set.
      Specified by:
      getGroupId in interface LayoutSetModel
      Returns:
      the group ID of this layout set
    • getLayoutSetId

      public long getLayoutSetId()
      Returns the layout set ID of this layout set.
      Specified by:
      getLayoutSetId in interface LayoutSetModel
      Returns:
      the layout set ID of this layout set
    • getLayoutSetPrototypeId

      public long getLayoutSetPrototypeId() throws PortalException
      Returns the layout set prototype's ID, or 0 if it has no layout set prototype.

      Prototype is Liferay's technical name for a site template.

      Specified by:
      getLayoutSetPrototypeId in interface LayoutSet
      Returns:
      the layout set prototype's ID, or 0 if it has no layout set prototype
      Throws:
      PortalException
    • getLayoutSetPrototypeLinkEnabled

      public boolean getLayoutSetPrototypeLinkEnabled()
      Returns the layout set prototype link enabled of this layout set.
      Specified by:
      getLayoutSetPrototypeLinkEnabled in interface LayoutSetModel
      Returns:
      the layout set prototype link enabled of this layout set
    • getLayoutSetPrototypeUuid

      public String getLayoutSetPrototypeUuid()
      Returns the layout set prototype uuid of this layout set.
      Specified by:
      getLayoutSetPrototypeUuid in interface LayoutSetModel
      Returns:
      the layout set prototype uuid of this layout set
    • getLiveLogoId

      public long getLiveLogoId()
      Specified by:
      getLiveLogoId in interface LayoutSet
    • getLogo

      public boolean getLogo()
      Specified by:
      getLogo in interface LayoutSet
    • getLogoId

      public long getLogoId()
      Returns the logo ID of this layout set.
      Specified by:
      getLogoId in interface LayoutSetModel
      Returns:
      the logo ID of this layout set
    • getMergeFailFriendlyURLLayouts

      public List<Layout> getMergeFailFriendlyURLLayouts()
      Specified by:
      getMergeFailFriendlyURLLayouts in interface LayoutSet
    • getModifiedDate

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

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

      public int getPageCount()
      Specified by:
      getPageCount in interface LayoutSet
    • getPrimaryKey

      public long getPrimaryKey()
      Returns the primary key of this layout set.
      Specified by:
      getPrimaryKey in interface CTModel<LayoutSet>
      Specified by:
      getPrimaryKey in interface LayoutSetModel
      Returns:
      the primary key of this layout set
    • getPrivateLayout

      public boolean getPrivateLayout()
      Returns the private layout of this layout set.
      Specified by:
      getPrivateLayout in interface LayoutSetModel
      Returns:
      the private layout of this layout set
    • getSettings

      public String getSettings()
      Returns the settings of this layout set.
      Specified by:
      getSettings in interface LayoutSetModel
      Returns:
      the settings of this layout set
    • getSettingsProperties

      public UnicodeProperties getSettingsProperties()
      Specified by:
      getSettingsProperties in interface LayoutSet
    • getSettingsProperty

      public String getSettingsProperty(String key)
      Specified by:
      getSettingsProperty in interface LayoutSet
    • getTheme

      public Theme getTheme()
      Specified by:
      getTheme in interface LayoutSet
    • getThemeId

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

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

      public TreeMap<String,String> getVirtualHostnames()
      Returns the names of the layout set's virtual hosts.

      When accessing a layout set that has a virtual host, the URL elements "/web/sitename" or "/group/sitename" can be omitted.

      Specified by:
      getVirtualHostnames in interface LayoutSet
      Returns:
      a map from the layout set's virtual host names to the language ids configured for them. If the virtual host is configured for the default language, it will map to the empty string instead of a language id. If the layout set has no virtual hosts configured, the returned map will be empty.
    • hasSetModifiedDate

      public boolean hasSetModifiedDate()
      Specified by:
      hasSetModifiedDate in interface LayoutSet
    • isLayoutSetPrototypeLinkActive

      public boolean isLayoutSetPrototypeLinkActive()
      Specified by:
      isLayoutSetPrototypeLinkActive in interface LayoutSet
    • isLayoutSetPrototypeLinkEnabled

      public boolean isLayoutSetPrototypeLinkEnabled()
      Returns true if this layout set is layout set prototype link enabled.
      Specified by:
      isLayoutSetPrototypeLinkEnabled in interface LayoutSetModel
      Returns:
      true if this layout set is layout set prototype link enabled; false otherwise
    • isLayoutSetPrototypeUpdateable

      public boolean isLayoutSetPrototypeUpdateable()
      Specified by:
      isLayoutSetPrototypeUpdateable in interface LayoutSet
    • isLayoutSetReadyForPropagation

      public boolean isLayoutSetReadyForPropagation()
      Specified by:
      isLayoutSetReadyForPropagation in interface LayoutSet
    • isLogo

      public boolean isLogo()
      Specified by:
      isLogo in interface LayoutSet
    • isPrivateLayout

      public boolean isPrivateLayout()
      Returns true if this layout set is private layout.
      Specified by:
      isPrivateLayout in interface LayoutSetModel
      Returns:
      true if this layout set is private layout; false otherwise
    • 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
    • setColorSchemeId

      public void setColorSchemeId(String colorSchemeId)
      Sets the color scheme ID of this layout set.
      Specified by:
      setColorSchemeId in interface LayoutSetModel
      Parameters:
      colorSchemeId - the color scheme ID of this layout set
    • setCompanyFallbackVirtualHostname

      public void setCompanyFallbackVirtualHostname(String companyFallbackVirtualHostname)
      Specified by:
      setCompanyFallbackVirtualHostname in interface LayoutSet
    • setCompanyId

      public void setCompanyId(long companyId)
      Sets the company ID of this layout set.
      Specified by:
      setCompanyId in interface LayoutSetModel
      Specified by:
      setCompanyId in interface ShardedModel
      Parameters:
      companyId - the company ID of this layout set
    • setCreateDate

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

      public void setCss(String css)
      Sets the css of this layout set.
      Specified by:
      setCss in interface LayoutSetModel
      Parameters:
      css - the css of this layout set
    • setCtCollectionId

      public void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this layout set.
      Specified by:
      setCtCollectionId in interface CTModel<LayoutSet>
      Specified by:
      setCtCollectionId in interface LayoutSetModel
      Parameters:
      ctCollectionId - the ct collection ID of this layout set
    • setFaviconFileEntryId

      public void setFaviconFileEntryId(long faviconFileEntryId)
      Sets the favicon file entry ID of this layout set.
      Specified by:
      setFaviconFileEntryId in interface LayoutSetModel
      Parameters:
      faviconFileEntryId - the favicon file entry ID of this layout set
    • setGroupId

      public void setGroupId(long groupId)
      Sets the group ID of this layout set.
      Specified by:
      setGroupId in interface LayoutSetModel
      Parameters:
      groupId - the group ID of this layout set
    • setLayoutSetId

      public void setLayoutSetId(long layoutSetId)
      Sets the layout set ID of this layout set.
      Specified by:
      setLayoutSetId in interface LayoutSetModel
      Parameters:
      layoutSetId - the layout set ID of this layout set
    • setLayoutSetPrototypeLinkEnabled

      public void setLayoutSetPrototypeLinkEnabled(boolean layoutSetPrototypeLinkEnabled)
      Sets whether this layout set is layout set prototype link enabled.
      Specified by:
      setLayoutSetPrototypeLinkEnabled in interface LayoutSetModel
      Parameters:
      layoutSetPrototypeLinkEnabled - the layout set prototype link enabled of this layout set
    • setLayoutSetPrototypeUuid

      public void setLayoutSetPrototypeUuid(String layoutSetPrototypeUuid)
      Sets the layout set prototype uuid of this layout set.
      Specified by:
      setLayoutSetPrototypeUuid in interface LayoutSetModel
      Parameters:
      layoutSetPrototypeUuid - the layout set prototype uuid of this layout set
    • setLogoId

      public void setLogoId(long logoId)
      Sets the logo ID of this layout set.
      Specified by:
      setLogoId in interface LayoutSetModel
      Parameters:
      logoId - the logo ID of this layout set
    • setModifiedDate

      public void setModifiedDate(Date modifiedDate)
      Sets the modified date of this layout set.
      Specified by:
      setModifiedDate in interface LayoutSetModel
      Parameters:
      modifiedDate - the modified date of this layout set
    • setMvccVersion

      public void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this layout set.
      Specified by:
      setMvccVersion in interface LayoutSetModel
      Specified by:
      setMvccVersion in interface MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this layout set
    • setPrimaryKey

      public void setPrimaryKey(long primaryKey)
      Sets the primary key of this layout set.
      Specified by:
      setPrimaryKey in interface CTModel<LayoutSet>
      Specified by:
      setPrimaryKey in interface LayoutSetModel
      Parameters:
      primaryKey - the primary key of this layout set
    • setPrivateLayout

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

      public void setSettings(String settings)
      Sets the settings of this layout set.
      Specified by:
      setSettings in interface LayoutSetModel
      Parameters:
      settings - the settings of this layout set
    • setSettingsProperties

      public void setSettingsProperties(UnicodeProperties settingsUnicodeProperties)
      Specified by:
      setSettingsProperties in interface LayoutSet
    • setThemeId

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

      public void setVirtualHostnames(TreeMap<String,String> virtualHostnames)
      Sets the names of the layout set's virtual host name and language IDs.
      Specified by:
      setVirtualHostnames in interface LayoutSet
      Parameters:
      virtualHostnames - the map of the layout set's virtual host name and language IDs
      See Also:
    • toXmlString

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

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

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

      protected LayoutSetWrapper wrap(LayoutSet layoutSet)
      Specified by:
      wrap in class BaseModelWrapper<LayoutSet>