com.liferay.portal.model
Interface Layout

All Superinterfaces:
BaseModel, java.lang.Cloneable, java.lang.Comparable, LayoutModel, java.io.Serializable

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 com.liferay.portal.service.model.impl.LayoutImpl and rerun the ServiceBuilder to generate the new methods.

Author:
Brian Wing Shun Chan
See Also:
com.liferay.portal.service.model.LayoutModel, com.liferay.portal.service.model.impl.LayoutImpl, com.liferay.portal.service.model.impl.LayoutModelImpl

Method Summary
 long getAncestorLayoutId()
           
 long getAncestorPlid()
           
 java.util.List getAncestors()
           
 java.util.List getChildren()
           
 java.util.List getChildren(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker)
           
 ColorScheme getColorScheme()
           
 java.lang.String getCssText()
           
 java.lang.String getDefaultFriendlyURL()
           
 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.lang.String localeLanguageId)
           
 java.lang.String getRegularURL(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getResetLayoutURL(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getResetMaxStateURL(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getTarget()
           
 Theme getTheme()
           
 java.lang.String getTitle(java.util.Locale locale)
           
 java.lang.String getTitle(java.lang.String localeLanguageId)
           
 java.lang.String getTypeSettings()
           
 java.util.Properties getTypeSettingsProperties()
           
 ColorScheme getWapColorScheme()
           
 Theme getWapTheme()
           
 boolean hasAncestor(long layoutId)
           
 boolean isFirstChild()
           
 boolean isFirstParent()
           
 boolean isInheritLookAndFeel()
           
 boolean isInheritWapLookAndFeel()
           
 boolean isRootLayout()
           
 boolean isSelected(boolean selectable, Layout layout, long ancestorPlid)
           
 boolean isShared()
           
 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(java.util.Properties typeSettingsProperties)
           
 
Methods inherited from interface com.liferay.portal.model.LayoutModel
getColorSchemeId, getCompanyId, getCss, getDescription, getDlFolderId, getFriendlyURL, getGroupId, getHidden, getIconImage, getIconImageId, getLayoutId, getName, getParentLayoutId, getPlid, getPrimaryKey, getPriority, getPrivateLayout, getThemeId, getTitle, getType, getWapColorSchemeId, getWapThemeId, isHidden, isIconImage, isPrivateLayout, setColorSchemeId, setCompanyId, setCss, setDescription, setDlFolderId, setFriendlyURL, setGroupId, setHidden, setIconImage, setIconImageId, setLayoutId, setName, setParentLayoutId, setPlid, setPrimaryKey, setPriority, setPrivateLayout, setThemeId, setTitle, setType, setWapColorSchemeId, setWapThemeId
 
Methods inherited from interface com.liferay.portal.model.BaseModel
clone, getPrimaryKeyObj, isNew, setNew
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getGroup

public Group getGroup()

isShared

public boolean isShared()

getAncestorPlid

public long getAncestorPlid()

getAncestorLayoutId

public long getAncestorLayoutId()

getAncestors

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

hasAncestor

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

isFirstParent

public boolean isFirstParent()

isFirstChild

public boolean isFirstChild()

isRootLayout

public boolean isRootLayout()

getChildren

public java.util.List getChildren()
                           throws com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getChildren

public java.util.List getChildren(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker)
                           throws com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getName

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

getName

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

setName

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

getTitle

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

getTitle

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

getHTMLTitle

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

getHTMLTitle

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

setTitle

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

getLayoutType

public LayoutType getLayoutType()

getTypeSettings

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

setTypeSettings

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

getTypeSettingsProperties

public java.util.Properties getTypeSettingsProperties()

setTypeSettingsProperties

public void setTypeSettingsProperties(java.util.Properties typeSettingsProperties)

getDefaultFriendlyURL

public java.lang.String getDefaultFriendlyURL()

getLayoutSet

public LayoutSet getLayoutSet()

isInheritLookAndFeel

public boolean isInheritLookAndFeel()

getTheme

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

getColorScheme

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

isInheritWapLookAndFeel

public boolean isInheritWapLookAndFeel()

getWapTheme

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

getWapColorScheme

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

getCssText

public java.lang.String getCssText()
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getRegularURL

public java.lang.String getRegularURL(javax.servlet.http.HttpServletRequest req)
                               throws com.liferay.portal.SystemException,
                                      com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getResetMaxStateURL

public java.lang.String getResetMaxStateURL(javax.servlet.http.HttpServletRequest req)
                                     throws com.liferay.portal.SystemException,
                                            com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getResetLayoutURL

public java.lang.String getResetLayoutURL(javax.servlet.http.HttpServletRequest req)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getTarget

public java.lang.String getTarget()

isSelected

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