Liferay 7.0-ce-b4

com.liferay.portal.model
Interface LayoutSet

All Superinterfaces:
BaseModel<LayoutSet>, ClassedModel, Cloneable, Comparable<LayoutSet>, LayoutSetModel, MVCCModel, PersistedModel, Serializable, ShardedModel
All Known Implementing Classes:
LayoutSetBaseImpl, LayoutSetImpl, 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.

See Also:
LayoutSetModel, LayoutSetImpl, LayoutSetModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Field Summary
static Accessor<LayoutSet,Long> LAYOUT_SET_ID_ACCESSOR
           
 
Method Summary
 ColorScheme getColorScheme()
          Returns the layout set's color scheme.
 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()
           
 UnicodeProperties getSettingsProperties()
           
 String getSettingsProperty(String key)
           
 Theme getTheme()
           
 String getThemeSetting(String key, String device)
           
 String getVirtualHostname()
          Returns the name of the layout set's virtual host.
 ColorScheme getWapColorScheme()
           
 Theme getWapTheme()
           
 boolean hasSetModifiedDate()
           
 boolean isLayoutSetPrototypeLinkActive()
           
 boolean isLogo()
           
 void setCompanyFallbackVirtualHostname(String companyFallbackVirtualHostname)
           
 void setSettingsProperties(UnicodeProperties settingsProperties)
           
 void setVirtualHostname(String virtualHostname)
          Sets the name of the layout set's virtual host.
 
Methods inherited from interface com.liferay.portal.model.LayoutSetModel
clone, compareTo, getColorSchemeId, getCompanyId, getCreateDate, getCss, getExpandoBridge, getGroupId, getLayoutSetId, getLayoutSetPrototypeLinkEnabled, getLayoutSetPrototypeUuid, getLogoId, getModifiedDate, getMvccVersion, getPageCount, getPrimaryKey, getPrimaryKeyObj, getPrivateLayout, getSettings, getThemeId, getWapColorSchemeId, getWapThemeId, hashCode, isCachedModel, isEscapedModel, isLayoutSetPrototypeLinkEnabled, isNew, isPrivateLayout, setCachedModel, setColorSchemeId, setCompanyId, setCreateDate, setCss, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setGroupId, setLayoutSetId, setLayoutSetPrototypeLinkEnabled, setLayoutSetPrototypeUuid, setLogoId, setModifiedDate, setMvccVersion, setNew, setPageCount, setPrimaryKey, setPrimaryKeyObj, setPrivateLayout, setSettings, setThemeId, setWapColorSchemeId, setWapThemeId, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 
Methods inherited from interface com.liferay.portal.model.PersistedModel
persist
 

Field Detail

LAYOUT_SET_ID_ACCESSOR

static final Accessor<LayoutSet,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

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

getSettingsProperties

UnicodeProperties getSettingsProperties()

getSettingsProperty

String getSettingsProperty(String key)

getTheme

Theme getTheme()

getThemeSetting

String getThemeSetting(String key,
                       String device)

getVirtualHostname

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.

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

getWapColorScheme

ColorScheme getWapColorScheme()

getWapTheme

Theme getWapTheme()

hasSetModifiedDate

boolean hasSetModifiedDate()

isLayoutSetPrototypeLinkActive

boolean isLayoutSetPrototypeLinkActive()

isLogo

boolean isLogo()

setCompanyFallbackVirtualHostname

void setCompanyFallbackVirtualHostname(String companyFallbackVirtualHostname)

setSettingsProperties

void setSettingsProperties(UnicodeProperties settingsProperties)

setVirtualHostname

void setVirtualHostname(String virtualHostname)
Sets the name of the layout set's virtual host.

Parameters:
virtualHostname - the name of the layout set's virtual host
See Also:
getVirtualHostname()

Liferay 7.0-ce-b4