com.liferay.portal.kernel.model.Group Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.portal.kernel Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
There is a newer version: 156.0.0
Show newest version
/**
 * Copyright (c) 2000-present 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.kernel.model;

import aQute.bnd.annotation.ProviderType;

import com.liferay.portal.kernel.annotation.ImplementationClassName;
import com.liferay.portal.kernel.util.Accessor;

/**
 * The extended model interface for the Group service. Represents a row in the "Group_" database table, with each column mapped to a property of this class.
 *
 * @author Brian Wing Shun Chan
 * @see GroupModel
 * @see com.liferay.portal.model.impl.GroupImpl
 * @see com.liferay.portal.model.impl.GroupModelImpl
 * @generated
 */
@ImplementationClassName("com.liferay.portal.model.impl.GroupImpl")
@ProviderType
public interface Group extends GroupModel, PersistedModel, TreeModel {
	/*
	 * NOTE FOR DEVELOPERS:
	 *
	 * Never modify this interface directly. Add methods to {@link com.liferay.portal.model.impl.GroupImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
	 */
	public static final Accessor GROUP_ID_ACCESSOR = new Accessor() {
			@Override
			public Long get(Group group) {
				return group.getGroupId();
			}

			@Override
			public Class getAttributeClass() {
				return Long.class;
			}

			@Override
			public Class getTypeClass() {
				return Group.class;
			}
		};

	public void clearStagingGroup();

	public java.util.List getAncestors()
		throws com.liferay.portal.kernel.exception.PortalException;

	public java.util.List getChildren(
		boolean site);

	/**
	* @deprecated As of 7.0.0, replaced by {@link
	#getChildrenWithLayouts(boolean, int, int,
	OrderByComparator)}
	*/
	@java.lang.Deprecated()
	public java.util.List getChildrenWithLayouts(
		boolean site, int start, int end);

	public java.util.List getChildrenWithLayouts(
		boolean site, int start, int end,
		com.liferay.portal.kernel.util.OrderByComparator obc);

	public int getChildrenWithLayoutsCount(boolean site);

	public long getDefaultPrivatePlid();

	public long getDefaultPublicPlid();

	public java.util.List getDescendants(
		boolean site);

	public java.lang.String getDescriptiveName()
		throws com.liferay.portal.kernel.exception.PortalException;

	public java.lang.String getDescriptiveName(java.util.Locale locale)
		throws com.liferay.portal.kernel.exception.PortalException;

	public java.lang.String getDisplayURL(
		com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay);

	public java.lang.String getDisplayURL(
		com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
		boolean privateLayout);

	public java.lang.String getIconCssClass();

	public java.lang.String getIconURL(
		com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay);

	public java.lang.String getLayoutRootNodeName(boolean privateLayout,
		java.util.Locale locale);

	public com.liferay.portal.kernel.model.Group getLiveGroup();

	public java.lang.String getLiveParentTypeSettingsProperty(
		java.lang.String key);

	public java.lang.String getLogoURL(
		com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
		boolean useDefault);

	public long getOrganizationId();

	public com.liferay.portal.kernel.model.Group getParentGroup()
		throws com.liferay.portal.kernel.exception.PortalException;

	public com.liferay.portal.kernel.util.UnicodeProperties getParentLiveGroupTypeSettingsProperties();

	public java.lang.String getPathFriendlyURL(boolean privateLayout,
		com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay);

	public com.liferay.portal.kernel.model.LayoutSet getPrivateLayoutSet();

	public int getPrivateLayoutsPageCount();

	public com.liferay.portal.kernel.model.LayoutSet getPublicLayoutSet();

	public int getPublicLayoutsPageCount();

	public long getRemoteLiveGroupId();

	public java.lang.String getScopeDescriptiveName(
		com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
		throws com.liferay.portal.kernel.exception.PortalException;

	public java.lang.String getScopeLabel(
		com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay);

	public com.liferay.portal.kernel.model.Group getStagingGroup();

	public java.lang.String getTypeLabel();

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

	public java.lang.String getTypeSettingsProperty(java.lang.String key);

	public java.lang.String getUnambiguousName(java.lang.String name,
		java.util.Locale locale);

	public boolean hasAncestor(long groupId);

	public boolean hasLocalOrRemoteStagingGroup();

	public boolean hasPrivateLayouts();

	public boolean hasPublicLayouts();

	public boolean hasRemoteStagingGroup();

	public boolean hasStagingGroup();

	/**
	* @deprecated As of 7.0.0, replaced by {@link #hasAncestor}
	*/
	@java.lang.Deprecated()
	public boolean isChild(long groupId);

	public boolean isCompany();

	public boolean isCompanyStagingGroup();

	public boolean isControlPanel();

	public boolean isGuest();

	public boolean isInStagingPortlet(java.lang.String portletId);

	public boolean isLayout();

	public boolean isLayoutPrototype();

	public boolean isLayoutSetPrototype();

	public boolean isLimitedToParentSiteMembers();

	public boolean isOrganization();

	public boolean isRegularSite();

	public boolean isRoot();

	public boolean isShowSite(
		com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker,
		boolean privateSite)
		throws com.liferay.portal.kernel.exception.PortalException;

	public boolean isStaged();

	public boolean isStagedPortlet(java.lang.String portletId);

	public boolean isStagedRemotely();

	public boolean isStagingGroup();

	public boolean isUser();

	public boolean isUserGroup();

	public boolean isUserPersonalSite();

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