com.liferay.portal.model
Interface Layout

All Superinterfaces:

BaseModel<Layout>, ClassedModel, Cloneable, Comparable<Layout>, LayoutModel, PersistedModel, Serializable

All Known Implementing Classes:

LayoutBaseImpl, LayoutImpl, LayoutWrapper, VirtualLayout

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.

See Also:

LayoutModel, LayoutImpl, LayoutModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Field Summary

static Accessor<Layout,Long>

LAYOUT_ID_ACCESSOR

Method Summary

List<Layout>	getAllChildren()
long	getAncestorLayoutId()
long	getAncestorPlid()
List<Layout>	getAncestors()
List<Layout>	getChildren()
List<Layout>	getChildren(PermissionChecker permissionChecker)
ColorScheme	getColorScheme()
String	getCssText()
Group	getGroup()
String	getHTMLTitle(Locale locale)
String	getHTMLTitle(String localeLanguageId)
LayoutSet	getLayoutSet()
LayoutType	getLayoutType()
long	getParentPlid()
String	getRegularURL(javax.servlet.http.HttpServletRequest request)
String	getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
String	getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
Group	getScopeGroup()
String	getTarget()
Theme	getTheme()
String	getThemeSetting(String key, String device)
String	getTypeSettings() Returns the type settings of this layout.
UnicodeProperties	getTypeSettingsProperties()
String	getTypeSettingsProperty(String key)
String	getTypeSettingsProperty(String key, 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	isTypeArticle()
boolean	isTypeControlPanel()
boolean	isTypeEmbedded()
boolean	isTypeLinkToLayout()
boolean	isTypePanel()
boolean	isTypePortlet()
boolean	isTypeURL()
void	setGroupId(long groupId) Sets the group ID of this layout.
void	setLayoutSet(LayoutSet layoutSet)
void	setPrivateLayout(boolean privateLayout) Sets whether this layout is private layout.
void	setTypeSettings(String typeSettings) Sets the type settings of this layout.
void	setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)

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

clone, compareTo, getColorSchemeId, getCompanyId, getCreateDate, getCss, 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, getUuid, getWapColorSchemeId, getWapThemeId, hashCode, isCachedModel, isEscapedModel, isHidden, isIconImage, isLayoutPrototypeLinkEnabled, isNew, isPrivateLayout, prepareLocalizedFieldsForImport, setCachedModel, setColorSchemeId, setCompanyId, setCreateDate, setCss, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setFriendlyURL, 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, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, 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.PersistedModel

persist

Field Detail

LAYOUT_ID_ACCESSOR

static final Accessor<Layout,Long> LAYOUT_ID_ACCESSOR

Method Detail

getAllChildren

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

List<Layout> getAncestors()
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getChildren

List<Layout> getChildren()
                         throws SystemException

Throws:

SystemException

getChildren

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

Throws:

PortalException

SystemException

getColorScheme

ColorScheme getColorScheme()
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getCssText

String getCssText()
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

getGroup

Group getGroup()
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getHTMLTitle

String getHTMLTitle(Locale locale)

getHTMLTitle

String getHTMLTitle(String localeLanguageId)

getLayoutSet

LayoutSet getLayoutSet()
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getLayoutType

LayoutType getLayoutType()

getParentPlid

long getParentPlid()
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getRegularURL

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

Throws:

PortalException

SystemException

getResetLayoutURL

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

Throws:

PortalException

SystemException

getResetMaxStateURL

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

Throws:

PortalException

SystemException

getScopeGroup

Group getScopeGroup()
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getTarget

String getTarget()

getTheme

Theme getTheme()
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getThemeSetting

String getThemeSetting(String key,
                       String device)

getTypeSettings

String getTypeSettings()

Description copied from interface: LayoutModel

Returns the type settings of this layout.

Specified by:

getTypeSettings in interface LayoutModel

Returns:

the type settings of this layout

getTypeSettingsProperties

UnicodeProperties getTypeSettingsProperties()

getTypeSettingsProperty

String getTypeSettingsProperty(String key)

getTypeSettingsProperty

String getTypeSettingsProperty(String key,
                               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)

isTypeArticle

boolean isTypeArticle()

isTypeControlPanel

boolean isTypeControlPanel()

isTypeEmbedded

boolean isTypeEmbedded()

isTypeLinkToLayout

boolean isTypeLinkToLayout()

isTypePanel

boolean isTypePanel()

isTypePortlet

boolean isTypePortlet()

isTypeURL

boolean isTypeURL()

setGroupId

void setGroupId(long groupId)

Description copied from interface: LayoutModel

Sets the group ID of this layout.

Specified by:

setGroupId in interface LayoutModel

Parameters:

groupId - the group ID of this layout

setLayoutSet

void setLayoutSet(LayoutSet layoutSet)

setPrivateLayout

void setPrivateLayout(boolean privateLayout)

Description copied from interface: LayoutModel

Sets whether this layout is private layout.

Specified by:

setPrivateLayout in interface LayoutModel

Parameters:

privateLayout - the private layout of this layout

setTypeSettings

void setTypeSettings(String typeSettings)

Description copied from interface: LayoutModel

Sets the type settings of this layout.

Specified by:

setTypeSettings in interface LayoutModel

Parameters:

typeSettings - the type settings of this layout

setTypeSettingsProperties

void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)