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 getDisplayURL(
071                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
072    
073            public java.lang.String getDisplayURL(
074                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
075                    boolean privateLayout);
076    
077            public java.lang.String getIconCssClass();
078    
079            public java.lang.String getIconURL(
080                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
081    
082            public java.lang.String getLayoutRootNodeName(boolean privateLayout,
083                    java.util.Locale locale);
084    
085            public com.liferay.portal.model.Group getLiveGroup();
086    
087            public java.lang.String getLiveParentTypeSettingsProperty(
088                    java.lang.String key);
089    
090            public long getOrganizationId();
091    
092            public com.liferay.portal.model.Group getParentGroup()
093                    throws com.liferay.portal.kernel.exception.PortalException;
094    
095            public com.liferay.portal.kernel.util.UnicodeProperties getParentLiveGroupTypeSettingsProperties();
096    
097            public java.lang.String getPathFriendlyURL(boolean privateLayout,
098                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
099    
100            public com.liferay.portal.model.LayoutSet getPrivateLayoutSet();
101    
102            public int getPrivateLayoutsPageCount();
103    
104            public com.liferay.portal.model.LayoutSet getPublicLayoutSet();
105    
106            public int getPublicLayoutsPageCount();
107    
108            public long getRemoteLiveGroupId();
109    
110            public java.lang.String getScopeDescriptiveName(
111                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
112                    throws com.liferay.portal.kernel.exception.PortalException;
113    
114            public java.lang.String getScopeLabel(
115                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
116    
117            public com.liferay.portal.model.Group getStagingGroup();
118    
119            public java.lang.String getTypeLabel();
120    
121            public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
122    
123            public java.lang.String getTypeSettingsProperty(java.lang.String key);
124    
125            public java.lang.String getUnambiguousName(java.lang.String name,
126                    java.util.Locale locale);
127    
128            public boolean hasAncestor(long groupId);
129    
130            public boolean hasLocalOrRemoteStagingGroup();
131    
132            public boolean hasPrivateLayouts();
133    
134            public boolean hasPublicLayouts();
135    
136            public boolean hasRemoteStagingGroup();
137    
138            public boolean hasStagingGroup();
139    
140            /**
141            * @deprecated As of 7.0.0, replaced by {@link #hasAncestor}
142            */
143            @java.lang.Deprecated()
144            public boolean isChild(long groupId);
145    
146            /**
147            * @deprecated As of 6.1.0, renamed to {@link #isRegularSite}
148            */
149            @java.lang.Deprecated()
150            public boolean isCommunity();
151    
152            public boolean isCompany();
153    
154            public boolean isCompanyStagingGroup();
155    
156            public boolean isControlPanel();
157    
158            public boolean isGuest();
159    
160            public boolean isInStagingPortlet(java.lang.String portletId);
161    
162            public boolean isLayout();
163    
164            public boolean isLayoutPrototype();
165    
166            public boolean isLayoutSetPrototype();
167    
168            public boolean isLimitedToParentSiteMembers();
169    
170            public boolean isOrganization();
171    
172            public boolean isRegularSite();
173    
174            public boolean isRoot();
175    
176            public boolean isShowSite(
177                    com.liferay.portal.security.permission.PermissionChecker permissionChecker,
178                    boolean privateSite)
179                    throws com.liferay.portal.kernel.exception.PortalException;
180    
181            public boolean isStaged();
182    
183            public boolean isStagedPortlet(java.lang.String portletId);
184    
185            public boolean isStagedRemotely();
186    
187            public boolean isStagingGroup();
188    
189            public boolean isUser();
190    
191            public boolean isUserGroup();
192    
193            public boolean isUserPersonalSite();
194    
195            public void setTypeSettingsProperties(
196                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
197    }