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    import com.liferay.portal.kernel.annotation.ImplementationClassName;
020    import com.liferay.portal.kernel.util.Accessor;
021    
022    /**
023     * 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.
024     *
025     * @author Brian Wing Shun Chan
026     * @see GroupModel
027     * @see com.liferay.portal.model.impl.GroupImpl
028     * @see com.liferay.portal.model.impl.GroupModelImpl
029     * @generated
030     */
031    @ImplementationClassName("com.liferay.portal.model.impl.GroupImpl")
032    @ProviderType
033    public interface Group extends GroupModel, PersistedModel, TreeModel {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039            public static final Accessor<Group, Long> GROUP_ID_ACCESSOR = new Accessor<Group, Long>() {
040                            @Override
041                            public Long get(Group group) {
042                                    return group.getGroupId();
043                            }
044    
045                            @Override
046                            public Class<Long> getAttributeClass() {
047                                    return Long.class;
048                            }
049    
050                            @Override
051                            public Class<Group> getTypeClass() {
052                                    return Group.class;
053                            }
054                    };
055    
056            public void clearStagingGroup();
057    
058            public java.util.List<com.liferay.portal.model.Group> getAncestors()
059                    throws com.liferay.portal.kernel.exception.PortalException;
060    
061            public java.util.List<com.liferay.portal.model.Group> getChildren(
062                    boolean site);
063    
064            /**
065            * @deprecated As of 7.0.0, replaced by {@link
066            #getChildrenWithLayouts(boolean, int, int,
067            OrderByComparator)}
068            */
069            @java.lang.Deprecated()
070            public java.util.List<com.liferay.portal.model.Group> getChildrenWithLayouts(
071                    boolean site, int start, int end);
072    
073            public java.util.List<com.liferay.portal.model.Group> getChildrenWithLayouts(
074                    boolean site, int start, int end,
075                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Group> obc);
076    
077            public int getChildrenWithLayoutsCount(boolean site);
078    
079            public long getDefaultPrivatePlid();
080    
081            public long getDefaultPublicPlid();
082    
083            public java.util.List<com.liferay.portal.model.Group> getDescendants(
084                    boolean site);
085    
086            public java.lang.String getDescriptiveName()
087                    throws com.liferay.portal.kernel.exception.PortalException;
088    
089            public java.lang.String getDescriptiveName(java.util.Locale locale)
090                    throws com.liferay.portal.kernel.exception.PortalException;
091    
092            public java.lang.String getDisplayURL(
093                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
094    
095            public java.lang.String getDisplayURL(
096                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
097                    boolean privateLayout);
098    
099            public java.lang.String getIconCssClass();
100    
101            public java.lang.String getIconURL(
102                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
103    
104            public java.lang.String getLayoutRootNodeName(boolean privateLayout,
105                    java.util.Locale locale);
106    
107            public com.liferay.portal.model.Group getLiveGroup();
108    
109            public java.lang.String getLiveParentTypeSettingsProperty(
110                    java.lang.String key);
111    
112            public java.lang.String getLogoURL(
113                    com.liferay.portal.theme.ThemeDisplay themeDisplay, boolean useDefault);
114    
115            public long getOrganizationId();
116    
117            public com.liferay.portal.model.Group getParentGroup()
118                    throws com.liferay.portal.kernel.exception.PortalException;
119    
120            public com.liferay.portal.kernel.util.UnicodeProperties getParentLiveGroupTypeSettingsProperties();
121    
122            public java.lang.String getPathFriendlyURL(boolean privateLayout,
123                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
124    
125            public com.liferay.portal.model.LayoutSet getPrivateLayoutSet();
126    
127            public int getPrivateLayoutsPageCount();
128    
129            public com.liferay.portal.model.LayoutSet getPublicLayoutSet();
130    
131            public int getPublicLayoutsPageCount();
132    
133            public long getRemoteLiveGroupId();
134    
135            public java.lang.String getScopeDescriptiveName(
136                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
137                    throws com.liferay.portal.kernel.exception.PortalException;
138    
139            public java.lang.String getScopeLabel(
140                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
141    
142            public com.liferay.portal.model.Group getStagingGroup();
143    
144            public java.lang.String getTypeLabel();
145    
146            public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
147    
148            public java.lang.String getTypeSettingsProperty(java.lang.String key);
149    
150            public java.lang.String getUnambiguousName(java.lang.String name,
151                    java.util.Locale locale);
152    
153            public boolean hasAncestor(long groupId);
154    
155            public boolean hasLocalOrRemoteStagingGroup();
156    
157            public boolean hasPrivateLayouts();
158    
159            public boolean hasPublicLayouts();
160    
161            public boolean hasRemoteStagingGroup();
162    
163            public boolean hasStagingGroup();
164    
165            /**
166            * @deprecated As of 7.0.0, replaced by {@link #hasAncestor}
167            */
168            @java.lang.Deprecated()
169            public boolean isChild(long groupId);
170    
171            public boolean isCompany();
172    
173            public boolean isCompanyStagingGroup();
174    
175            public boolean isControlPanel();
176    
177            public boolean isGuest();
178    
179            public boolean isInStagingPortlet(java.lang.String portletId);
180    
181            public boolean isLayout();
182    
183            public boolean isLayoutPrototype();
184    
185            public boolean isLayoutSetPrototype();
186    
187            public boolean isLimitedToParentSiteMembers();
188    
189            public boolean isOrganization();
190    
191            public boolean isRegularSite();
192    
193            public boolean isRoot();
194    
195            public boolean isShowSite(
196                    com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker,
197                    boolean privateSite)
198                    throws com.liferay.portal.kernel.exception.PortalException;
199    
200            public boolean isStaged();
201    
202            public boolean isStagedPortlet(java.lang.String portletId);
203    
204            public boolean isStagedRemotely();
205    
206            public boolean isStagingGroup();
207    
208            public boolean isUser();
209    
210            public boolean isUserGroup();
211    
212            public boolean isUserPersonalSite();
213    
214            public void setTypeSettingsProperties(
215                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
216    }