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