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