com.liferay.portal.kernel.model

Interface LayoutSet

All Superinterfaces:

BaseModel<LayoutSet>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<LayoutSet>, CTModel<LayoutSet>, LayoutSetModel, MVCCModel, PersistedModel, java.io.Serializable, ShardedModel

All Known Implementing Classes:

LayoutSetWrapper

@ProviderType
public interface LayoutSet
extends LayoutSetModel, PersistedModel

The extended model interface for the LayoutSet service. Represents a row in the "LayoutSet" database table, with each column mapped to a property of this class.

Author:

Brian Wing Shun Chan

See Also:

LayoutSetModel

Generated:

Field Summary

Fields

Modifier and Type	Field and Description
static Accessor<LayoutSet,java.lang.Long>	LAYOUT_SET_ID_ACCESSOR

Method Summary

Modifier and Type	Method and Description
ColorScheme	getColorScheme() Returns the layout set's color scheme.
java.lang.String	getCompanyFallbackVirtualHostname()
Group	getGroup() Returns the layout set's group.
long	getLayoutSetPrototypeId() Returns the layout set prototype's ID, or 0 if it has no layout set prototype.
long	getLiveLogoId()
boolean	getLogo()
int	getPageCount()
UnicodeProperties	getSettingsProperties()
java.lang.String	getSettingsProperty(java.lang.String key)
Theme	getTheme()
java.lang.String	getThemeSetting(java.lang.String key, java.lang.String device)
java.lang.String	getVirtualHostname() Deprecated. As of Mueller (7.2.x), replaced by getVirtualHostnames()
java.util.TreeMap<java.lang.String,java.lang.String>	getVirtualHostnames() Returns the names of the layout set's virtual hosts.
boolean	hasSetModifiedDate()
boolean	isLayoutSetPrototypeLinkActive()
boolean	isLogo()
void	setCompanyFallbackVirtualHostname(java.lang.String companyFallbackVirtualHostname)
void	setSettingsProperties(UnicodeProperties settingsUnicodeProperties)
void	setVirtualHostname(java.lang.String virtualHostname) Deprecated. As of Mueller (7.2.x), replaced by setVirtualHostnames(TreeMap)
void	setVirtualHostnames(java.util.TreeMap<java.lang.String,java.lang.String> virtualHostnames) Sets the names of the layout set's virtual host name and language IDs.

Methods inherited from interface com.liferay.portal.kernel.model.LayoutSetModel

getColorSchemeId, getCompanyId, getCreateDate, getCss, getCtCollectionId, getGroupId, getLayoutSetId, getLayoutSetPrototypeLinkEnabled, getLayoutSetPrototypeUuid, getLogoId, getModifiedDate, getMvccVersion, getPrimaryKey, getPrivateLayout, getSettings, getThemeId, isLayoutSetPrototypeLinkEnabled, isPrivateLayout, setColorSchemeId, setCompanyId, setCreateDate, setCss, setCtCollectionId, setGroupId, setLayoutSetId, setLayoutSetPrototypeLinkEnabled, setLayoutSetPrototypeUuid, setLogoId, setModifiedDate, setMvccVersion, setPrimaryKey, setPrivateLayout, setSettings, setThemeId

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.liferay.portal.kernel.model.PersistedModel

persist

Field Detail

LAYOUT_SET_ID_ACCESSOR

static final Accessor<LayoutSet,java.lang.Long> LAYOUT_SET_ID_ACCESSOR

Method Detail

getColorScheme

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.

Returns:

the layout set's color scheme

getCompanyFallbackVirtualHostname

java.lang.String getCompanyFallbackVirtualHostname()

getGroup

Group getGroup()
        throws PortalException

Returns the layout set's group.

Returns:

the layout set's group

Throws:

PortalException

getLayoutSetPrototypeId

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.

Returns:

the layout set prototype's ID, or 0 if it has no layout set prototype

Throws:

PortalException

getLiveLogoId

long getLiveLogoId()

getLogo

boolean getLogo()

getPageCount

int getPageCount()

getSettingsProperties

UnicodeProperties getSettingsProperties()

getSettingsProperty

java.lang.String getSettingsProperty(java.lang.String key)

getTheme

Theme getTheme()

getThemeSetting

java.lang.String getThemeSetting(java.lang.String key,
                                 java.lang.String device)

getVirtualHostname

@Deprecated
java.lang.String getVirtualHostname()

Deprecated. As of Mueller (7.2.x), replaced by getVirtualHostnames()

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

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

Returns:

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

getVirtualHostnames

java.util.TreeMap<java.lang.String,java.lang.String> getVirtualHostnames()

Returns the names of the layout set's virtual hosts.

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

Returns:

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

hasSetModifiedDate

boolean hasSetModifiedDate()

isLayoutSetPrototypeLinkActive

boolean isLayoutSetPrototypeLinkActive()

isLogo

boolean isLogo()

setCompanyFallbackVirtualHostname

void setCompanyFallbackVirtualHostname(java.lang.String companyFallbackVirtualHostname)

setSettingsProperties

void setSettingsProperties(UnicodeProperties settingsUnicodeProperties)

setVirtualHostname

@Deprecated
void setVirtualHostname(java.lang.String virtualHostname)

Deprecated. As of Mueller (7.2.x), replaced by setVirtualHostnames(TreeMap)

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

Parameters:

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

See Also:

getVirtualHostname()

setVirtualHostnames

void setVirtualHostnames(java.util.TreeMap<java.lang.String,java.lang.String> virtualHostnames)

Sets the names of the layout set's virtual host name and language IDs.

Parameters:

virtualHostnames - the map of the layout set's virtual host name and language IDs

See Also:

getVirtualHostnames()