Liferay 6.0.5

com.liferay.portal.model
Interface Layout

All Superinterfaces:
BaseModel<Layout>, Cloneable, Comparable<Layout>, LayoutModel, Serializable
All Known Implementing Classes:
LayoutImpl, LayoutWrapper

public interface Layout
extends LayoutModel

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

Never modify this interface directly. Add methods to LayoutImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Never reference this interface directly. All methods that expect a layout model instance should use the Layout interface instead.

See Also:
LayoutModel, LayoutImpl, LayoutModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

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()
           
 String getName(Locale locale)
           
 String getName(Locale locale, boolean useDefault)
           
 String getName(String localeLanguageId)
           
 String getName(String localeLanguageId, boolean useDefault)
           
 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 getTitle(Locale locale)
           
 String getTitle(Locale locale, boolean useDefault)
           
 String getTitle(String localeLanguageId)
           
 String getTitle(String localeLanguageId, boolean useDefault)
           
 String getTypeSettings()
          Gets the type settings of this layout.
 UnicodeProperties getTypeSettingsProperties()
           
 ColorScheme getWapColorScheme()
           
 Theme getWapTheme()
           
 boolean hasAncestor(long layoutId)
           
 boolean hasChildren()
           
 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(String name, Locale locale)
           
 void setTitle(String title, Locale locale)
           
 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, getCss, getDescription, getDlFolderId, getExpandoBridge, getFriendlyURL, getGroupId, getHidden, getIconImage, getIconImageId, getLayoutId, getLayoutPrototypeId, getName, getParentLayoutId, getPlid, getPrimaryKey, getPrimaryKeyObj, getPriority, getPrivateLayout, getThemeId, getTitle, getType, getUuid, getWapColorSchemeId, getWapThemeId, hashCode, isCachedModel, isEscapedModel, isHidden, isIconImage, isNew, isPrivateLayout, setCachedModel, setColorSchemeId, setCompanyId, setCss, setDescription, setDlFolderId, setEscapedModel, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setHidden, setIconImage, setIconImageId, setLayoutId, setLayoutPrototypeId, setName, setNew, setParentLayoutId, setPlid, setPrimaryKey, setPriority, setPrivateLayout, setThemeId, setTitle, setType, setUuid, setWapColorSchemeId, setWapThemeId, toEscapedModel, toString, toXmlString
 

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

getName

String getName(Locale locale)

getName

String getName(Locale locale,
               boolean useDefault)

getName

String getName(String localeLanguageId)

getName

String getName(String localeLanguageId,
               boolean useDefault)

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

getTitle

String getTitle(Locale locale)

getTitle

String getTitle(Locale locale,
                boolean useDefault)

getTitle

String getTitle(String localeLanguageId)

getTitle

String getTitle(String localeLanguageId,
                boolean useDefault)

getTypeSettings

String getTypeSettings()
Description copied from interface: LayoutModel
Gets the type settings of this layout.

Specified by:
getTypeSettings in interface LayoutModel
Returns:
the type settings of this layout

getTypeSettingsProperties

UnicodeProperties getTypeSettingsProperties()

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

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(String name,
             Locale locale)

setTitle

void setTitle(String title,
              Locale locale)

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)

Liferay 6.0.5