com.liferay.portal.model.Layout Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.model;
import com.liferay.portal.kernel.util.Accessor;
/**
* 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.
*
* @author Brian Wing Shun Chan
* @see LayoutModel
* @see com.liferay.portal.model.impl.LayoutImpl
* @see com.liferay.portal.model.impl.LayoutModelImpl
* @generated
*/
public interface Layout extends LayoutModel, PersistedModel {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add methods to {@link com.liferay.portal.model.impl.LayoutImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public static final Accessor LAYOUT_ID_ACCESSOR = new Accessor() {
@Override
public Long get(Layout layout) {
return layout.getLayoutId();
}
};
public java.util.List getAllChildren()
throws com.liferay.portal.kernel.exception.SystemException;
public long getAncestorLayoutId()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public long getAncestorPlid()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.util.List getAncestors()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.util.List getChildren()
throws com.liferay.portal.kernel.exception.SystemException;
public java.util.List getChildren(
com.liferay.portal.security.permission.PermissionChecker permissionChecker)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.ColorScheme getColorScheme()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.lang.String getCssText()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.lang.String getFriendlyURL(java.util.Locale locale);
public java.util.Map getFriendlyURLMap()
throws com.liferay.portal.kernel.exception.SystemException;
public java.lang.String getFriendlyURLsXML()
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Group getGroup()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.lang.String getHTMLTitle(java.util.Locale locale);
public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
public com.liferay.portal.model.LayoutSet getLayoutSet()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutType getLayoutType();
public long getParentPlid()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.lang.String getRegularURL(
javax.servlet.http.HttpServletRequest request)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.lang.String getResetLayoutURL(
javax.servlet.http.HttpServletRequest request)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.lang.String getResetMaxStateURL(
javax.servlet.http.HttpServletRequest request)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Group getScopeGroup()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.lang.String getTarget();
public com.liferay.portal.model.Theme getTheme()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public java.lang.String getThemeSetting(java.lang.String key,
java.lang.String device);
public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
public java.lang.String getTypeSettingsProperty(java.lang.String key);
public java.lang.String getTypeSettingsProperty(java.lang.String key,
java.lang.String defaultValue);
public com.liferay.portal.model.ColorScheme getWapColorScheme()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Theme getWapTheme()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public boolean hasAncestor(long layoutId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public boolean hasChildren()
throws com.liferay.portal.kernel.exception.SystemException;
public boolean hasScopeGroup()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public boolean isChildSelected(boolean selectable,
com.liferay.portal.model.Layout layout)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public boolean isContentDisplayPage();
public boolean isFirstChild();
public boolean isFirstParent();
public boolean isInheritLookAndFeel();
public boolean isInheritWapLookAndFeel();
public boolean isLayoutPrototypeLinkActive();
public boolean isPublicLayout();
public boolean isRootLayout();
public boolean isSelected(boolean selectable,
com.liferay.portal.model.Layout layout, long ancestorPlid);
public boolean isSupportsEmbeddedPortlets();
public boolean isTypeArticle();
public boolean isTypeControlPanel();
public boolean isTypeEmbedded();
public boolean isTypeLinkToLayout();
public boolean isTypePanel();
public boolean isTypePortlet();
public boolean isTypeURL();
public void setLayoutSet(com.liferay.portal.model.LayoutSet layoutSet);
public void setTypeSettingsProperties(
com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
}