001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.model;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    /**
020     * 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.
021     *
022     * @author Brian Wing Shun Chan
023     * @see GroupModel
024     * @see com.liferay.portal.model.impl.GroupImpl
025     * @see com.liferay.portal.model.impl.GroupModelImpl
026     * @generated
027     */
028    @ProviderType
029    public interface Group extends GroupModel, PersistedModel, TreeModel {
030            /*
031             * NOTE FOR DEVELOPERS:
032             *
033             * 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.
034             */
035            public void clearStagingGroup();
036    
037            public java.util.List<com.liferay.portal.model.Group> getAncestors()
038                    throws com.liferay.portal.kernel.exception.PortalException;
039    
040            public java.util.List<com.liferay.portal.model.Group> getChildren(
041                    boolean site);
042    
043            /**
044            * @deprecated As of 7.0.0, replaced by {@link
045            #getChildrenWithLayouts(boolean, int, int, OrderByComparator}
046            */
047            @java.lang.Deprecated()
048            public java.util.List<com.liferay.portal.model.Group> getChildrenWithLayouts(
049                    boolean site, int start, int end);
050    
051            public java.util.List<com.liferay.portal.model.Group> getChildrenWithLayouts(
052                    boolean site, int start, int end,
053                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Group> obc);
054    
055            public int getChildrenWithLayoutsCount(boolean site);
056    
057            public long getDefaultPrivatePlid();
058    
059            public long getDefaultPublicPlid();
060    
061            public java.util.List<com.liferay.portal.model.Group> getDescendants(
062                    boolean site);
063    
064            public java.lang.String getDescriptiveName()
065                    throws com.liferay.portal.kernel.exception.PortalException;
066    
067            public java.lang.String getDescriptiveName(java.util.Locale locale)
068                    throws com.liferay.portal.kernel.exception.PortalException;
069    
070            public java.lang.String getIconCssClass();
071    
072            public java.lang.String getIconURL(
073                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
074    
075            public java.lang.String getLayoutRootNodeName(boolean privateLayout,
076                    java.util.Locale locale);
077    
078            public com.liferay.portal.model.Group getLiveGroup();
079    
080            public java.lang.String getLiveParentTypeSettingsProperty(
081                    java.lang.String key);
082    
083            public long getOrganizationId();
084    
085            public com.liferay.portal.model.Group getParentGroup()
086                    throws com.liferay.portal.kernel.exception.PortalException;
087    
088            public com.liferay.portal.kernel.util.UnicodeProperties getParentLiveGroupTypeSettingsProperties();
089    
090            public java.lang.String getPathFriendlyURL(boolean privateLayout,
091                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
092    
093            public com.liferay.portal.model.LayoutSet getPrivateLayoutSet();
094    
095            public int getPrivateLayoutsPageCount();
096    
097            public com.liferay.portal.model.LayoutSet getPublicLayoutSet();
098    
099            public int getPublicLayoutsPageCount();
100    
101            public long getRemoteLiveGroupId();
102    
103            public java.lang.String getScopeDescriptiveName(
104                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
105                    throws com.liferay.portal.kernel.exception.PortalException;
106    
107            public java.lang.String getScopeLabel(
108                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
109    
110            public com.liferay.portal.model.Group getStagingGroup();
111    
112            public java.lang.String getTypeLabel();
113    
114            public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
115    
116            public java.lang.String getTypeSettingsProperty(java.lang.String key);
117    
118            public java.lang.String getUnambiguousName(java.lang.String name,
119                    java.util.Locale locale);
120    
121            public boolean hasAncestor(long groupId);
122    
123            public boolean hasLocalOrRemoteStagingGroup();
124    
125            public boolean hasPrivateLayouts();
126    
127            public boolean hasPublicLayouts();
128    
129            public boolean hasRemoteStagingGroup();
130    
131            public boolean hasStagingGroup();
132    
133            /**
134            * @deprecated As of 7.0.0, replaced by {@link #hasAncestor}
135            */
136            @java.lang.Deprecated()
137            public boolean isChild(long groupId);
138    
139            /**
140            * @deprecated As of 6.1.0, renamed to {@link #isRegularSite}
141            */
142            @java.lang.Deprecated()
143            public boolean isCommunity();
144    
145            public boolean isCompany();
146    
147            public boolean isCompanyStagingGroup();
148    
149            public boolean isControlPanel();
150    
151            public boolean isGuest();
152    
153            public boolean isInStagingPortlet(java.lang.String portletId);
154    
155            public boolean isLayout();
156    
157            public boolean isLayoutPrototype();
158    
159            public boolean isLayoutSetPrototype();
160    
161            public boolean isLimitedToParentSiteMembers();
162    
163            public boolean isOrganization();
164    
165            public boolean isRegularSite();
166    
167            public boolean isRoot();
168    
169            public boolean isShowSite(
170                    com.liferay.portal.security.permission.PermissionChecker permissionChecker,
171                    boolean privateSite)
172                    throws com.liferay.portal.kernel.exception.PortalException;
173    
174            public boolean isStaged();
175    
176            public boolean isStagedPortlet(java.lang.String portletId);
177    
178            public boolean isStagedRemotely();
179    
180            public boolean isStagingGroup();
181    
182            public boolean isUser();
183    
184            public boolean isUserGroup();
185    
186            public boolean isUserPersonalSite();
187    
188            public void setTypeSettingsProperties(
189                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
190    }