001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.model;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.model.PersistedModel;
020    import com.liferay.portal.model.TreeModel;
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    @ProviderType
032    public interface Group extends GroupModel, PersistedModel, TreeModel {
033            /*
034             * NOTE FOR DEVELOPERS:
035             *
036             * 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.
037             */
038            public void clearStagingGroup();
039    
040            public java.util.List<com.liferay.portal.model.Group> getAncestors()
041                    throws com.liferay.portal.kernel.exception.PortalException,
042                            com.liferay.portal.kernel.exception.SystemException;
043    
044            public java.util.List<com.liferay.portal.model.Group> getChildren(
045                    boolean site)
046                    throws com.liferay.portal.kernel.exception.SystemException;
047    
048            /**
049            * @deprecated As of 7.0.0, replaced by {@link
050            #getChildrenWithLayouts(boolean, int, int, OrderByComparator}
051            */
052            @java.lang.Deprecated()
053            public java.util.List<com.liferay.portal.model.Group> getChildrenWithLayouts(
054                    boolean site, int start, int end)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            public java.util.List<com.liferay.portal.model.Group> getChildrenWithLayouts(
058                    boolean site, int start, int end,
059                    com.liferay.portal.kernel.util.OrderByComparator obc)
060                    throws com.liferay.portal.kernel.exception.SystemException;
061    
062            public int getChildrenWithLayoutsCount(boolean site)
063                    throws com.liferay.portal.kernel.exception.SystemException;
064    
065            public long getDefaultPrivatePlid();
066    
067            public long getDefaultPublicPlid();
068    
069            public java.lang.String getDescriptiveName()
070                    throws com.liferay.portal.kernel.exception.PortalException,
071                            com.liferay.portal.kernel.exception.SystemException;
072    
073            public java.lang.String getDescriptiveName(java.util.Locale locale)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            public java.lang.String getDisplayURL(
078                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
079                    throws com.liferay.portal.kernel.exception.PortalException;
080    
081            public java.lang.String getDisplayURL(
082                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
083                    boolean privateLayout)
084                    throws com.liferay.portal.kernel.exception.PortalException;
085    
086            public java.lang.String getIconURL(
087                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
088    
089            public java.lang.String getLayoutRootNodeName(boolean privateLayout,
090                    java.util.Locale locale);
091    
092            public com.liferay.portal.model.Group getLiveGroup();
093    
094            public java.lang.String getLiveParentTypeSettingsProperty(
095                    java.lang.String key);
096    
097            public long getOrganizationId();
098    
099            public com.liferay.portal.model.Group getParentGroup()
100                    throws com.liferay.portal.kernel.exception.PortalException,
101                            com.liferay.portal.kernel.exception.SystemException;
102    
103            public com.liferay.portal.kernel.util.UnicodeProperties getParentLiveGroupTypeSettingsProperties();
104    
105            public java.lang.String getPathFriendlyURL(boolean privateLayout,
106                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
107    
108            public com.liferay.portal.model.LayoutSet getPrivateLayoutSet();
109    
110            public int getPrivateLayoutsPageCount();
111    
112            public com.liferay.portal.model.LayoutSet getPublicLayoutSet();
113    
114            public int getPublicLayoutsPageCount();
115    
116            public java.lang.String getScopeDescriptiveName(
117                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
118                    throws com.liferay.portal.kernel.exception.PortalException,
119                            com.liferay.portal.kernel.exception.SystemException;
120    
121            public java.lang.String getScopeLabel(
122                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
123    
124            public com.liferay.portal.model.Group getStagingGroup();
125    
126            public java.lang.String getTypeLabel();
127    
128            public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
129    
130            public java.lang.String getTypeSettingsProperty(java.lang.String key);
131    
132            public java.lang.String getUnambiguousName(java.lang.String name,
133                    java.util.Locale locale);
134    
135            public boolean hasAncestor(long groupId);
136    
137            public boolean hasLocalOrRemoteStagingGroup();
138    
139            public boolean hasPrivateLayouts();
140    
141            public boolean hasPublicLayouts();
142    
143            public boolean hasStagingGroup();
144    
145            /**
146            * @deprecated As of 7.0.0, replaced by {@link #hasAncestor}
147            */
148            public boolean isChild(long groupId);
149    
150            /**
151            * @deprecated As of 6.1.0, renamed to {@link #isRegularSite}
152            */
153            public boolean isCommunity();
154    
155            public boolean isCompany();
156    
157            public boolean isCompanyStagingGroup();
158    
159            public boolean isControlPanel();
160    
161            public boolean isGuest();
162    
163            public boolean isInStagingPortlet(java.lang.String portletId);
164    
165            public boolean isLayout();
166    
167            public boolean isLayoutPrototype();
168    
169            public boolean isLayoutSetPrototype();
170    
171            public boolean isLimitedToParentSiteMembers();
172    
173            public boolean isOrganization();
174    
175            public boolean isRegularSite();
176    
177            public boolean isRoot();
178    
179            public boolean isShowSite(
180                    com.liferay.portal.security.permission.PermissionChecker permissionChecker,
181                    boolean privateSite)
182                    throws com.liferay.portal.kernel.exception.PortalException,
183                            com.liferay.portal.kernel.exception.SystemException;
184    
185            public boolean isStaged();
186    
187            public boolean isStagedPortlet(java.lang.String portletId);
188    
189            public boolean isStagedRemotely();
190    
191            public boolean isStagingGroup();
192    
193            public boolean isUser();
194    
195            public boolean isUserGroup();
196    
197            public boolean isUserPersonalSite();
198    
199            public void setTypeSettingsProperties(
200                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
201    }