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