com.liferay.portal.kernel.model

Class LayoutSetWrapper

Object

com.liferay.portal.kernel.model.LayoutSetWrapper

All Implemented Interfaces:

BaseModel<LayoutSet>, ClassedModel, LayoutSet, LayoutSetModel, ModelWrapper<LayoutSet>, MVCCModel, PersistedModel, ShardedModel, Serializable, Cloneable, Comparable<LayoutSet>

@ProviderType
public class LayoutSetWrapper
extends Object
implements LayoutSet, ModelWrapper<LayoutSet>

This class is a wrapper for LayoutSet.

Author:

Brian Wing Shun Chan

See Also:

LayoutSet, Serialized Form

{$generated.description}

Field Summary

Fields inherited from interface com.liferay.portal.kernel.model.LayoutSet

LAYOUT_SET_ID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
LayoutSetWrapper(LayoutSet layoutSet)

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a shallow clone of this model instance.
int	compareTo(LayoutSet layoutSet)
boolean	equals(Object obj)
ColorScheme	getColorScheme() Returns the layout set's color scheme.
String	getColorSchemeId() Returns the color scheme ID of this layout set.
String	getCompanyFallbackVirtualHostname()
long	getCompanyId() Returns the company ID of this layout set.
Date	getCreateDate() Returns the create date of this layout set.
String	getCss() Returns the css of this layout set.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
Group	getGroup() Returns the layout set's group.
long	getGroupId() Returns the group ID of this layout set.
long	getLayoutSetId() Returns the layout set ID of this layout set.
long	getLayoutSetPrototypeId() Returns the layout set prototype's ID, or 0 if it has no layout set prototype.
boolean	getLayoutSetPrototypeLinkEnabled() Returns the layout set prototype link enabled of this layout set.
String	getLayoutSetPrototypeUuid() Returns the layout set prototype uuid of this layout set.
long	getLiveLogoId()
boolean	getLogo()
long	getLogoId() Returns the logo ID of this layout set.
Map<String,Object>	getModelAttributes()
Class<?>	getModelClass()
String	getModelClassName()
Date	getModifiedDate() Returns the modified date of this layout set.
long	getMvccVersion() Returns the mvcc version of this layout set.
int	getPageCount() Returns the page count of this layout set.
long	getPrimaryKey() Returns the primary key of this layout set.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
boolean	getPrivateLayout() Returns the private layout of this layout set.
String	getSettings() Returns the settings of this layout set.
UnicodeProperties	getSettingsProperties()
String	getSettingsProperty(String key)
Theme	getTheme()
String	getThemeId() Returns the theme ID of this layout set.
String	getThemeSetting(String key, String device)
String	getVirtualHostname() Returns the name of the layout set's virtual host.
LayoutSet	getWrappedModel()
int	hashCode()
boolean	hasSetModifiedDate()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEntityCacheEnabled() Returns true if this model's entity cache is enabled.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isFinderCacheEnabled() Returns true if this model's finder cache is enabled.
boolean	isLayoutSetPrototypeLinkActive()
boolean	isLayoutSetPrototypeLinkEnabled() Returns true if this layout set is layout set prototype link enabled.
boolean	isLogo()
boolean	isNew() Returns true if this model instance does not yet exist in the database.
boolean	isPrivateLayout() Returns true if this layout set is private layout.
void	persist() Updates this model instance in the database or adds it if it does not yet exist.
void	resetOriginalValues() Reset all original fields to current values.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setColorSchemeId(String colorSchemeId) Sets the color scheme ID of this layout set.
void	setCompanyFallbackVirtualHostname(String companyFallbackVirtualHostname)
void	setCompanyId(long companyId) Sets the company ID of this layout set.
void	setCreateDate(Date createDate) Sets the create date of this layout set.
void	setCss(String css) Sets the css of this layout set.
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setGroupId(long groupId) Sets the group ID of this layout set.
void	setLayoutSetId(long layoutSetId) Sets the layout set ID of this layout set.
void	setLayoutSetPrototypeLinkEnabled(boolean layoutSetPrototypeLinkEnabled) Sets whether this layout set is layout set prototype link enabled.
void	setLayoutSetPrototypeUuid(String layoutSetPrototypeUuid) Sets the layout set prototype uuid of this layout set.
void	setLogoId(long logoId) Sets the logo ID of this layout set.
void	setModelAttributes(Map<String,Object> attributes)
void	setModifiedDate(Date modifiedDate) Sets the modified date of this layout set.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this layout set.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPageCount(int pageCount) Sets the page count of this layout set.
void	setPrimaryKey(long primaryKey) Sets the primary key of this layout set.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setPrivateLayout(boolean privateLayout) Sets whether this layout set is private layout.
void	setSettings(String settings) Sets the settings of this layout set.
void	setSettingsProperties(UnicodeProperties settingsProperties)
void	setThemeId(String themeId) Sets the theme ID of this layout set.
void	setVirtualHostname(String virtualHostname) Sets the name of the layout set's virtual host.
CacheModel<LayoutSet>	toCacheModel() Returns a cache model object for this entity used by entity cache.
LayoutSet	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
LayoutSet	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LayoutSetWrapper

public LayoutSetWrapper(LayoutSet layoutSet)

Method Detail

getModelClass

public Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()

Specified by:

getModelClassName in interface ClassedModel

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>

clone

public Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<LayoutSet>

Specified by:

clone in interface LayoutSetModel

Overrides:

clone in class Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(LayoutSet layoutSet)

Specified by:

compareTo in interface LayoutSetModel

Specified by:

compareTo in interface Comparable<LayoutSet>

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

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<LayoutSet>

Specified by:

getExpandoBridge in interface ClassedModel

Specified by:

getExpandoBridge in interface LayoutSetModel

Returns:

the expando bridge for this model instance

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

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()

Returns the page count of this layout set.

Specified by:

getPageCount in interface LayoutSetModel

Returns:

the page count of this layout set

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this layout set.

Specified by:

getPrimaryKey in interface LayoutSetModel

Returns:

the primary key of this layout set

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<LayoutSet>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Specified by:

getPrimaryKeyObj in interface LayoutSetModel

Returns:

the primary key of this model instance

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

getVirtualHostname

public String getVirtualHostname()

Returns the name of the layout set's virtual host.

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

Specified by:

getVirtualHostname in interface LayoutSet

Returns:

the layout set's virtual host name, or an empty string if the layout set has no virtual host configured

hashCode

public int hashCode()

Specified by:

hashCode in interface LayoutSetModel

Overrides:

hashCode in class Object

hasSetModifiedDate

public boolean hasSetModifiedDate()

Specified by:

hasSetModifiedDate in interface LayoutSet

isCachedModel

public boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<LayoutSet>

Specified by:

isCachedModel in interface LayoutSetModel

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<LayoutSet>

Specified by:

isEscapedModel in interface LayoutSetModel

Returns:

true if this model instance is escaped; false otherwise

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

isLogo

public boolean isLogo()

Specified by:

isLogo in interface LayoutSet

isNew

public boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<LayoutSet>

Specified by:

isNew in interface LayoutSetModel

Returns:

true if this model instance does not yet exist in the database; false otherwise

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

setCachedModel

public void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<LayoutSet>

Specified by:

setCachedModel in interface LayoutSetModel

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

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

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<LayoutSet>

Specified by:

setExpandoBridgeAttributes in interface LayoutSetModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<LayoutSet>

Specified by:

setExpandoBridgeAttributes in interface LayoutSetModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<LayoutSet>

Specified by:

setExpandoBridgeAttributes in interface LayoutSetModel

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes()

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

setNew

public void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<LayoutSet>

Specified by:

setNew in interface LayoutSetModel

Parameters:

n - whether this model instance does not yet exist in the database

setPageCount

public void setPageCount(int pageCount)

Sets the page count of this layout set.

Specified by:

setPageCount in interface LayoutSetModel

Parameters:

pageCount - the page count of this layout set

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Sets the primary key of this layout set.

Specified by:

setPrimaryKey in interface LayoutSetModel

Parameters:

primaryKey - the primary key of this layout set

setPrimaryKeyObj

public void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<LayoutSet>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Specified by:

setPrimaryKeyObj in interface LayoutSetModel

Parameters:

primaryKeyObj - the primary key of this model instance

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 settingsProperties)

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

setVirtualHostname

public void setVirtualHostname(String virtualHostname)

Sets the name of the layout set's virtual host.

Specified by:

setVirtualHostname in interface LayoutSet

Parameters:

virtualHostname - the name of the layout set's virtual host

See Also:

getVirtualHostname()

toCacheModel

public CacheModel<LayoutSet> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<LayoutSet>

Specified by:

toCacheModel in interface LayoutSetModel

Returns:

the cache model object

toEscapedModel

public LayoutSet toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<LayoutSet>

Specified by:

toEscapedModel in interface LayoutSetModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toString

public String toString()

Specified by:

toString in interface LayoutSetModel

Overrides:

toString in class Object

toUnescapedModel

public LayoutSet toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<LayoutSet>

Specified by:

toUnescapedModel in interface LayoutSetModel

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<LayoutSet>

Specified by:

toXmlString in interface LayoutSetModel

Returns:

the XML representation of this model instance

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getWrappedModel

public LayoutSet getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<LayoutSet>

isEntityCacheEnabled

public boolean isEntityCacheEnabled()

Description copied from interface: BaseModel

Returns true if this model's entity cache is enabled.

Specified by:

isEntityCacheEnabled in interface BaseModel<LayoutSet>

Returns:

true if this model's entity cache is enabled; false otherwise

isFinderCacheEnabled

public boolean isFinderCacheEnabled()

Description copied from interface: BaseModel

Returns true if this model's finder cache is enabled.

Specified by:

isFinderCacheEnabled in interface BaseModel<LayoutSet>

Returns:

true if this model's finder cache is enabled; false otherwise

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<LayoutSet>