com.liferay.portal.model
Interface Layout

All Superinterfaces:
BaseModel<Layout>, java.lang.Cloneable, java.lang.Comparable<Layout>, LayoutModel, java.io.Serializable
All Known Implementing Classes:
LayoutWrapper

public interface Layout
extends LayoutModel

View Source

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

This interface is a model that represents the Layout table in the database.

Customize LayoutImpl and rerun the ServiceBuilder to generate the new methods.

Author:
Brian Wing Shun Chan
See Also:
LayoutModel, LayoutImpl, LayoutModelImpl
Generated:

Method Summary
 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()
           
 Group getGroup()
           
 java.lang.String getHTMLTitle(java.util.Locale locale)
           
 java.lang.String getHTMLTitle(java.lang.String localeLanguageId)
           
 LayoutSet getLayoutSet()
           
 LayoutType getLayoutType()
           
 java.lang.String getName(java.util.Locale locale)
           
 java.lang.String getName(java.util.Locale locale, boolean useDefault)
           
 java.lang.String getName(java.lang.String localeLanguageId)
           
 java.lang.String getName(java.lang.String localeLanguageId, boolean useDefault)
           
 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 getTitle(java.util.Locale locale)
           
 java.lang.String getTitle(java.util.Locale locale, boolean useDefault)
           
 java.lang.String getTitle(java.lang.String localeLanguageId)
           
 java.lang.String getTitle(java.lang.String localeLanguageId, boolean useDefault)
           
 java.lang.String getTypeSettings()
           
 com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties()
           
 ColorScheme getWapColorScheme()
           
 Theme getWapTheme()
           
 boolean hasAncestor(long layoutId)
           
 boolean hasScopeGroup()
           
 boolean isChildSelected(boolean selectable, Layout layout)
           
 boolean isFirstChild()
           
 boolean isFirstParent()
           
 boolean isInheritLookAndFeel()
           
 boolean isInheritWapLookAndFeel()
           
 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 setName(java.lang.String name, java.util.Locale locale)
           
 void setTitle(java.lang.String title, java.util.Locale locale)
           
 void setTypeSettings(java.lang.String typeSettings)
           
 void setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)
           
 
Methods inherited from interface com.liferay.portal.model.LayoutModel
clone, compareTo, getColorSchemeId, getCompanyId, getCss, getDescription, getDlFolderId, getExpandoBridge, getFriendlyURL, getGroupId, getHidden, getIconImage, getIconImageId, getLayoutId, getName, getParentLayoutId, getPlid, getPrimaryKey, getPrimaryKeyObj, getPriority, getPrivateLayout, getThemeId, getTitle, getType, getWapColorSchemeId, getWapThemeId, hashCode, isCachedModel, isEscapedModel, isHidden, isIconImage, isNew, isPrivateLayout, setCachedModel, setColorSchemeId, setCompanyId, setCss, setDescription, setDlFolderId, setEscapedModel, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setHidden, setIconImage, setIconImageId, setLayoutId, setName, setNew, setParentLayoutId, setPlid, setPrimaryKey, setPriority, setPrivateLayout, setThemeId, setTitle, setType, setWapColorSchemeId, setWapThemeId, toEscapedModel, toString, toXmlString
 

Method Detail

getAllChildren

java.util.List<Layout> getAllChildren()
                                      throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getAncestorLayoutId

long getAncestorLayoutId()

getAncestorPlid

long getAncestorPlid()

getAncestors

java.util.List<Layout> getAncestors()
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getChildren

java.util.List<Layout> getChildren()
                                   throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getChildren

java.util.List<Layout> getChildren(PermissionChecker permissionChecker)
                                   throws com.liferay.portal.PortalException,
                                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getColorScheme

ColorScheme getColorScheme()
                           throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getCssText

java.lang.String getCssText()

getGroup

Group getGroup()

getHTMLTitle

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

getHTMLTitle

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

getLayoutSet

LayoutSet getLayoutSet()

getLayoutType

LayoutType getLayoutType()

getName

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

getName

java.lang.String getName(java.util.Locale locale,
                         boolean useDefault)

getName

java.lang.String getName(java.lang.String localeLanguageId)

getName

java.lang.String getName(java.lang.String localeLanguageId,
                         boolean useDefault)

getParentPlid

long getParentPlid()
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getRegularURL

java.lang.String getRegularURL(javax.servlet.http.HttpServletRequest request)
                               throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getResetLayoutURL

java.lang.String getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
                                   throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getResetMaxStateURL

java.lang.String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
                                     throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getScopeGroup

Group getScopeGroup()
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getTarget

java.lang.String getTarget()

getTheme

Theme getTheme()
               throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getTitle

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

getTitle

java.lang.String getTitle(java.util.Locale locale,
                          boolean useDefault)

getTitle

java.lang.String getTitle(java.lang.String localeLanguageId)

getTitle

java.lang.String getTitle(java.lang.String localeLanguageId,
                          boolean useDefault)

getTypeSettings

java.lang.String getTypeSettings()
Specified by:
getTypeSettings in interface LayoutModel

getTypeSettingsProperties

com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties()

getWapColorScheme

ColorScheme getWapColorScheme()
                              throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getWapTheme

Theme getWapTheme()
                  throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

hasAncestor

boolean hasAncestor(long layoutId)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

hasScopeGroup

boolean hasScopeGroup()
                      throws com.liferay.portal.PortalException,
                             com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

isChildSelected

boolean isChildSelected(boolean selectable,
                        Layout layout)

isFirstChild

boolean isFirstChild()

isFirstParent

boolean isFirstParent()

isInheritLookAndFeel

boolean isInheritLookAndFeel()

isInheritWapLookAndFeel

boolean isInheritWapLookAndFeel()

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

setName

void setName(java.lang.String name,
             java.util.Locale locale)

setTitle

void setTitle(java.lang.String title,
              java.util.Locale locale)

setTypeSettings

void setTypeSettings(java.lang.String typeSettings)
Specified by:
setTypeSettings in interface LayoutModel

setTypeSettingsProperties

void setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)