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