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