Liferay 6.2.0

com.liferay.portal.model
Interface Layout

All Superinterfaces:
AuditedModel, BaseModel<Layout>, ClassedModel, Cloneable, Comparable<Layout>, GroupedModel, LayoutModel, PersistedModel, 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.

See Also:
LayoutModel, LayoutImpl, LayoutModelImpl

Field Summary
static Accessor<Layout,Long> LAYOUT_ID_ACCESSOR
           
 
Method Summary
abstract  List<Layout> getAllChildren()
           
abstract  long getAncestorLayoutId()
           
abstract  long getAncestorPlid()
           
abstract  List<Layout> getAncestors()
           
abstract  List<Layout> getChildren()
           
abstract  List<Layout> getChildren(PermissionChecker permissionChecker)
           
abstract  ColorScheme getColorScheme()
           
abstract  String getCssText()
           
abstract  String getFriendlyURL(Locale locale)
           
abstract  Map<Locale,String> getFriendlyURLMap()
           
abstract  String getFriendlyURLsXML()
           
abstract  Group getGroup()
           
abstract  String getHTMLTitle(Locale locale)
           
abstract  String getHTMLTitle(String localeLanguageId)
           
abstract  LayoutSet getLayoutSet()
           
abstract  LayoutType getLayoutType()
           
abstract  long getParentPlid()
           
abstract  String getRegularURL(javax.servlet.http.HttpServletRequest request)
           
abstract  String getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
           
abstract  String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
           
abstract  Group getScopeGroup()
           
abstract  String getTarget()
           
abstract  Theme getTheme()
           
abstract  String getThemeSetting(String key, String device)
           
abstract  UnicodeProperties getTypeSettingsProperties()
           
abstract  String getTypeSettingsProperty(String key)
           
abstract  String getTypeSettingsProperty(String key, String defaultValue)
           
abstract  ColorScheme getWapColorScheme()
           
abstract  Theme getWapTheme()
           
abstract  boolean hasAncestor(long layoutId)
           
abstract  boolean hasChildren()
           
abstract  boolean hasScopeGroup()
           
abstract  boolean isChildSelected(boolean selectable, Layout layout)
           
abstract  boolean isContentDisplayPage()
           
abstract  boolean isFirstChild()
           
abstract  boolean isFirstParent()
           
abstract  boolean isInheritLookAndFeel()
           
abstract  boolean isInheritWapLookAndFeel()
           
abstract  boolean isLayoutPrototypeLinkActive()
           
abstract  boolean isPublicLayout()
           
abstract  boolean isRootLayout()
           
abstract  boolean isSelected(boolean selectable, Layout layout, long ancestorPlid)
           
abstract  boolean isSupportsEmbeddedPortlets()
           
abstract  boolean isTypeArticle()
           
abstract  boolean isTypeControlPanel()
           
abstract  boolean isTypeEmbedded()
           
abstract  boolean isTypeLinkToLayout()
           
abstract  boolean isTypePanel()
           
abstract  boolean isTypePortlet()
           
abstract  boolean isTypeURL()
           
abstract  void setLayoutSet(LayoutSet layoutSet)
           
abstract  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,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

getFriendlyURL

String getFriendlyURL(Locale locale)

getFriendlyURLMap

Map<Locale,String> getFriendlyURLMap()
                                     throws SystemException
Throws:
SystemException

getFriendlyURLsXML

String getFriendlyURLsXML()
                          throws SystemException
Throws:
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)

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)

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)

Liferay 6.2.0