com.liferay.portal.model

Interface Layout

All Superinterfaces:

AuditedModel, BaseModel<Layout>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<Layout>, GroupedModel, LayoutModel, PersistedModel, java.io.Serializable, StagedGroupedModel, StagedModel

All Known Implementing Classes:

LayoutWrapper

@ProviderType
public interface Layout
extends LayoutModel, PersistedModel

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

Author:

Brian Wing Shun Chan

See Also:

LayoutModel, LayoutImpl, LayoutModelImpl

Generated:

Field Summary

Fields

Modifier and Type	Field and Description
static Accessor<Layout,java.lang.Long>	LAYOUT_ID_ACCESSOR

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<Layout>	getAllChildren()
long	getAncestorLayoutId()
long	getAncestorPlid()
java.util.List<Layout>	getAncestors()
java.util.List<Layout>	getChildren()
java.util.List<Layout>	getChildren(PermissionChecker permissionChecker)
ColorScheme	getColorScheme()
java.lang.String	getCssText()
java.lang.String	getFriendlyURL(java.util.Locale locale)
java.util.Map<java.util.Locale,java.lang.String>	getFriendlyURLMap()
java.lang.String	getFriendlyURLsXML()
Group	getGroup()
java.lang.String	getHTMLTitle(java.util.Locale locale)
java.lang.String	getHTMLTitle(java.lang.String localeLanguageId)
LayoutSet	getLayoutSet()
LayoutType	getLayoutType()
long	getParentPlid()
java.lang.String	getRegularURL(javax.servlet.http.HttpServletRequest request)
java.lang.String	getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
java.lang.String	getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
Group	getScopeGroup()
java.lang.String	getTarget()
Theme	getTheme()
java.lang.String	getThemeSetting(java.lang.String key, java.lang.String device)
UnicodeProperties	getTypeSettingsProperties()
java.lang.String	getTypeSettingsProperty(java.lang.String key)
java.lang.String	getTypeSettingsProperty(java.lang.String key, java.lang.String defaultValue)
ColorScheme	getWapColorScheme()
Theme	getWapTheme()
boolean	hasAncestor(long layoutId)
boolean	hasChildren()
boolean	hasScopeGroup()
boolean	isChildSelected(boolean selectable, Layout layout)
boolean	isContentDisplayPage()
boolean	isFirstChild()
boolean	isFirstParent()
boolean	isInheritLookAndFeel()
boolean	isInheritWapLookAndFeel()
boolean	isLayoutPrototypeLinkActive()
boolean	isPublicLayout()
boolean	isRootLayout()
boolean	isSelected(boolean selectable, Layout layout, long ancestorPlid)
boolean	isSupportsEmbeddedPortlets()
boolean	isTypeArticle()
boolean	isTypeControlPanel()
boolean	isTypeEmbedded()
boolean	isTypeLinkToLayout()
boolean	isTypePanel()
boolean	isTypePortlet()
boolean	isTypeURL()
void	setLayoutSet(LayoutSet layoutSet)
void	setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)

Methods inherited from interface com.liferay.portal.model.LayoutModel

clone, compareTo, getAvailableLanguageIds, getColorSchemeId, getCompanyId, getCreateDate, getCss, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getFriendlyURL, getGroupId, getHidden, getIconImage, getIconImageId, getKeywords, getKeywords, getKeywords, getKeywords, getKeywords, getKeywordsCurrentLanguageId, getKeywordsCurrentValue, getKeywordsMap, getLayoutId, getLayoutPrototypeLinkEnabled, getLayoutPrototypeUuid, getModifiedDate, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getParentLayoutId, getPlid, getPrimaryKey, getPrimaryKeyObj, getPriority, getPrivateLayout, getRobots, getRobots, getRobots, getRobots, getRobots, getRobotsCurrentLanguageId, getRobotsCurrentValue, getRobotsMap, getSourcePrototypeLayoutUuid, getThemeId, getTitle, getTitle, getTitle, getTitle, getTitle, getTitleCurrentLanguageId, getTitleCurrentValue, getTitleMap, getType, getTypeSettings, getUserId, getUserName, getUserUuid, getUuid, getWapColorSchemeId, getWapThemeId, hashCode, isCachedModel, isEscapedModel, isHidden, isIconImage, isLayoutPrototypeLinkEnabled, isNew, isPrivateLayout, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setCachedModel, setColorSchemeId, setCompanyId, setCreateDate, setCss, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setHidden, setIconImage, setIconImageId, setKeywords, setKeywords, setKeywords, setKeywordsCurrentLanguageId, setKeywordsMap, setKeywordsMap, setLayoutId, setLayoutPrototypeLinkEnabled, setLayoutPrototypeUuid, setModifiedDate, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setNew, setParentLayoutId, setPlid, setPrimaryKey, setPrimaryKeyObj, setPriority, setPrivateLayout, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, setTypeSettings, setUserId, setUserName, setUserUuid, setUuid, setWapColorSchemeId, setWapThemeId, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString

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

getModelAttributes, resetOriginalValues, setModelAttributes

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

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.model.StagedModel

getStagedModelType

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

persist

Field Detail

LAYOUT_ID_ACCESSOR

static final Accessor<Layout,java.lang.Long> LAYOUT_ID_ACCESSOR

Method Detail

getAllChildren

java.util.List<Layout> getAllChildren()
                                      throws SystemException

Throws:

SystemException

getAncestorLayoutId

long getAncestorLayoutId()
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getAncestorPlid

long getAncestorPlid()
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getAncestors

java.util.List<Layout> getAncestors()
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getChildren

java.util.List<Layout> getChildren()
                                   throws SystemException

Throws:

SystemException

getChildren

java.util.List<Layout> getChildren(PermissionChecker permissionChecker)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getColorScheme

ColorScheme getColorScheme()
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getCssText

java.lang.String getCssText()
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getFriendlyURL

java.lang.String getFriendlyURL(java.util.Locale locale)

getFriendlyURLMap

java.util.Map<java.util.Locale,java.lang.String> getFriendlyURLMap()
                                                                   throws SystemException

Throws:

SystemException

getFriendlyURLsXML

java.lang.String getFriendlyURLsXML()
                                    throws SystemException

Throws:

SystemException

getGroup

Group getGroup()
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getHTMLTitle

java.lang.String getHTMLTitle(java.util.Locale locale)

getHTMLTitle

java.lang.String getHTMLTitle(java.lang.String localeLanguageId)

getLayoutSet

LayoutSet getLayoutSet()
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getLayoutType

LayoutType getLayoutType()

getParentPlid

long getParentPlid()
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getRegularURL

java.lang.String getRegularURL(javax.servlet.http.HttpServletRequest request)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getResetLayoutURL

java.lang.String getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getResetMaxStateURL

java.lang.String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

getScopeGroup

Group getScopeGroup()
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getTarget

java.lang.String getTarget()

getTheme

Theme getTheme()
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getThemeSetting

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

getTypeSettingsProperties

UnicodeProperties getTypeSettingsProperties()

getTypeSettingsProperty

java.lang.String getTypeSettingsProperty(java.lang.String key)

getTypeSettingsProperty

java.lang.String getTypeSettingsProperty(java.lang.String key,
                                       java.lang.String defaultValue)

getWapColorScheme

ColorScheme getWapColorScheme()
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getWapTheme

Theme getWapTheme()
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

hasAncestor

boolean hasAncestor(long layoutId)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

hasChildren

boolean hasChildren()
                    throws SystemException

Throws:

SystemException

hasScopeGroup

boolean hasScopeGroup()
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

isChildSelected

boolean isChildSelected(boolean selectable,
                      Layout layout)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

isContentDisplayPage

boolean isContentDisplayPage()

isFirstChild

boolean isFirstChild()

isFirstParent

boolean isFirstParent()

isInheritLookAndFeel

boolean isInheritLookAndFeel()

isInheritWapLookAndFeel

boolean isInheritWapLookAndFeel()

isLayoutPrototypeLinkActive

boolean isLayoutPrototypeLinkActive()

isPublicLayout

boolean isPublicLayout()

isRootLayout

boolean isRootLayout()

isSelected

boolean isSelected(boolean selectable,
                 Layout layout,
                 long ancestorPlid)

isSupportsEmbeddedPortlets

boolean isSupportsEmbeddedPortlets()

isTypeArticle

boolean isTypeArticle()

isTypeControlPanel

boolean isTypeControlPanel()

isTypeEmbedded

boolean isTypeEmbedded()

isTypeLinkToLayout

boolean isTypeLinkToLayout()

isTypePanel

boolean isTypePanel()

isTypePortlet

boolean isTypePortlet()

isTypeURL

boolean isTypeURL()

setLayoutSet

void setLayoutSet(LayoutSet layoutSet)

setTypeSettingsProperties

void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)