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.bean.AutoEscape;
020    import com.liferay.portal.service.ServiceContext;
021    
022    import com.liferay.portlet.expando.model.ExpandoBridge;
023    
024    import java.io.Serializable;
025    
026    /**
027     * The base model interface for the Group service. Represents a row in the "Group_" database table, with each column mapped to a property of this class.
028     *
029     * <p>
030     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.GroupModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portal.model.impl.GroupImpl}.
031     * </p>
032     *
033     * @author Brian Wing Shun Chan
034     * @see Group
035     * @see com.liferay.portal.model.impl.GroupImpl
036     * @see com.liferay.portal.model.impl.GroupModelImpl
037     * @generated
038     */
039    @ProviderType
040    public interface GroupModel extends AttachedModel, BaseModel<Group>, MVCCModel {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. All methods that expect a group model instance should use the {@link Group} interface instead.
045             */
046    
047            /**
048             * Returns the primary key of this group.
049             *
050             * @return the primary key of this group
051             */
052            public long getPrimaryKey();
053    
054            /**
055             * Sets the primary key of this group.
056             *
057             * @param primaryKey the primary key of this group
058             */
059            public void setPrimaryKey(long primaryKey);
060    
061            /**
062             * Returns the mvcc version of this group.
063             *
064             * @return the mvcc version of this group
065             */
066            @Override
067            public long getMvccVersion();
068    
069            /**
070             * Sets the mvcc version of this group.
071             *
072             * @param mvccVersion the mvcc version of this group
073             */
074            @Override
075            public void setMvccVersion(long mvccVersion);
076    
077            /**
078             * Returns the uuid of this group.
079             *
080             * @return the uuid of this group
081             */
082            @AutoEscape
083            public String getUuid();
084    
085            /**
086             * Sets the uuid of this group.
087             *
088             * @param uuid the uuid of this group
089             */
090            public void setUuid(String uuid);
091    
092            /**
093             * Returns the group ID of this group.
094             *
095             * @return the group ID of this group
096             */
097            public long getGroupId();
098    
099            /**
100             * Sets the group ID of this group.
101             *
102             * @param groupId the group ID of this group
103             */
104            public void setGroupId(long groupId);
105    
106            /**
107             * Returns the company ID of this group.
108             *
109             * @return the company ID of this group
110             */
111            public long getCompanyId();
112    
113            /**
114             * Sets the company ID of this group.
115             *
116             * @param companyId the company ID of this group
117             */
118            public void setCompanyId(long companyId);
119    
120            /**
121             * Returns the creator user ID of this group.
122             *
123             * @return the creator user ID of this group
124             */
125            public long getCreatorUserId();
126    
127            /**
128             * Sets the creator user ID of this group.
129             *
130             * @param creatorUserId the creator user ID of this group
131             */
132            public void setCreatorUserId(long creatorUserId);
133    
134            /**
135             * Returns the creator user uuid of this group.
136             *
137             * @return the creator user uuid of this group
138             */
139            public String getCreatorUserUuid();
140    
141            /**
142             * Sets the creator user uuid of this group.
143             *
144             * @param creatorUserUuid the creator user uuid of this group
145             */
146            public void setCreatorUserUuid(String creatorUserUuid);
147    
148            /**
149             * Returns the fully qualified class name of this group.
150             *
151             * @return the fully qualified class name of this group
152             */
153            @Override
154            public String getClassName();
155    
156            public void setClassName(String className);
157    
158            /**
159             * Returns the class name ID of this group.
160             *
161             * @return the class name ID of this group
162             */
163            @Override
164            public long getClassNameId();
165    
166            /**
167             * Sets the class name ID of this group.
168             *
169             * @param classNameId the class name ID of this group
170             */
171            @Override
172            public void setClassNameId(long classNameId);
173    
174            /**
175             * Returns the class p k of this group.
176             *
177             * @return the class p k of this group
178             */
179            @Override
180            public long getClassPK();
181    
182            /**
183             * Sets the class p k of this group.
184             *
185             * @param classPK the class p k of this group
186             */
187            @Override
188            public void setClassPK(long classPK);
189    
190            /**
191             * Returns the parent group ID of this group.
192             *
193             * @return the parent group ID of this group
194             */
195            public long getParentGroupId();
196    
197            /**
198             * Sets the parent group ID of this group.
199             *
200             * @param parentGroupId the parent group ID of this group
201             */
202            public void setParentGroupId(long parentGroupId);
203    
204            /**
205             * Returns the live group ID of this group.
206             *
207             * @return the live group ID of this group
208             */
209            public long getLiveGroupId();
210    
211            /**
212             * Sets the live group ID of this group.
213             *
214             * @param liveGroupId the live group ID of this group
215             */
216            public void setLiveGroupId(long liveGroupId);
217    
218            /**
219             * Returns the tree path of this group.
220             *
221             * @return the tree path of this group
222             */
223            @AutoEscape
224            public String getTreePath();
225    
226            /**
227             * Sets the tree path of this group.
228             *
229             * @param treePath the tree path of this group
230             */
231            public void setTreePath(String treePath);
232    
233            /**
234             * Returns the name of this group.
235             *
236             * @return the name of this group
237             */
238            @AutoEscape
239            public String getName();
240    
241            /**
242             * Sets the name of this group.
243             *
244             * @param name the name of this group
245             */
246            public void setName(String name);
247    
248            /**
249             * Returns the description of this group.
250             *
251             * @return the description of this group
252             */
253            @AutoEscape
254            public String getDescription();
255    
256            /**
257             * Sets the description of this group.
258             *
259             * @param description the description of this group
260             */
261            public void setDescription(String description);
262    
263            /**
264             * Returns the type of this group.
265             *
266             * @return the type of this group
267             */
268            public int getType();
269    
270            /**
271             * Sets the type of this group.
272             *
273             * @param type the type of this group
274             */
275            public void setType(int type);
276    
277            /**
278             * Returns the type settings of this group.
279             *
280             * @return the type settings of this group
281             */
282            @AutoEscape
283            public String getTypeSettings();
284    
285            /**
286             * Sets the type settings of this group.
287             *
288             * @param typeSettings the type settings of this group
289             */
290            public void setTypeSettings(String typeSettings);
291    
292            /**
293             * Returns the manual membership of this group.
294             *
295             * @return the manual membership of this group
296             */
297            public boolean getManualMembership();
298    
299            /**
300             * Returns <code>true</code> if this group is manual membership.
301             *
302             * @return <code>true</code> if this group is manual membership; <code>false</code> otherwise
303             */
304            public boolean isManualMembership();
305    
306            /**
307             * Sets whether this group is manual membership.
308             *
309             * @param manualMembership the manual membership of this group
310             */
311            public void setManualMembership(boolean manualMembership);
312    
313            /**
314             * Returns the membership restriction of this group.
315             *
316             * @return the membership restriction of this group
317             */
318            public int getMembershipRestriction();
319    
320            /**
321             * Sets the membership restriction of this group.
322             *
323             * @param membershipRestriction the membership restriction of this group
324             */
325            public void setMembershipRestriction(int membershipRestriction);
326    
327            /**
328             * Returns the friendly u r l of this group.
329             *
330             * @return the friendly u r l of this group
331             */
332            @AutoEscape
333            public String getFriendlyURL();
334    
335            /**
336             * Sets the friendly u r l of this group.
337             *
338             * @param friendlyURL the friendly u r l of this group
339             */
340            public void setFriendlyURL(String friendlyURL);
341    
342            /**
343             * Returns the site of this group.
344             *
345             * @return the site of this group
346             */
347            public boolean getSite();
348    
349            /**
350             * Returns <code>true</code> if this group is site.
351             *
352             * @return <code>true</code> if this group is site; <code>false</code> otherwise
353             */
354            public boolean isSite();
355    
356            /**
357             * Sets whether this group is site.
358             *
359             * @param site the site of this group
360             */
361            public void setSite(boolean site);
362    
363            /**
364             * Returns the remote staging group count of this group.
365             *
366             * @return the remote staging group count of this group
367             */
368            public int getRemoteStagingGroupCount();
369    
370            /**
371             * Sets the remote staging group count of this group.
372             *
373             * @param remoteStagingGroupCount the remote staging group count of this group
374             */
375            public void setRemoteStagingGroupCount(int remoteStagingGroupCount);
376    
377            /**
378             * Returns the inherit content of this group.
379             *
380             * @return the inherit content of this group
381             */
382            public boolean getInheritContent();
383    
384            /**
385             * Returns <code>true</code> if this group is inherit content.
386             *
387             * @return <code>true</code> if this group is inherit content; <code>false</code> otherwise
388             */
389            public boolean isInheritContent();
390    
391            /**
392             * Sets whether this group is inherit content.
393             *
394             * @param inheritContent the inherit content of this group
395             */
396            public void setInheritContent(boolean inheritContent);
397    
398            /**
399             * Returns the active of this group.
400             *
401             * @return the active of this group
402             */
403            public boolean getActive();
404    
405            /**
406             * Returns <code>true</code> if this group is active.
407             *
408             * @return <code>true</code> if this group is active; <code>false</code> otherwise
409             */
410            public boolean isActive();
411    
412            /**
413             * Sets whether this group is active.
414             *
415             * @param active the active of this group
416             */
417            public void setActive(boolean active);
418    
419            @Override
420            public boolean isNew();
421    
422            @Override
423            public void setNew(boolean n);
424    
425            @Override
426            public boolean isCachedModel();
427    
428            @Override
429            public void setCachedModel(boolean cachedModel);
430    
431            @Override
432            public boolean isEscapedModel();
433    
434            @Override
435            public Serializable getPrimaryKeyObj();
436    
437            @Override
438            public void setPrimaryKeyObj(Serializable primaryKeyObj);
439    
440            @Override
441            public ExpandoBridge getExpandoBridge();
442    
443            @Override
444            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
445    
446            @Override
447            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
448    
449            @Override
450            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
451    
452            @Override
453            public Object clone();
454    
455            @Override
456            public int compareTo(com.liferay.portal.model.Group group);
457    
458            @Override
459            public int hashCode();
460    
461            @Override
462            public CacheModel<com.liferay.portal.model.Group> toCacheModel();
463    
464            @Override
465            public com.liferay.portal.model.Group toEscapedModel();
466    
467            @Override
468            public com.liferay.portal.model.Group toUnescapedModel();
469    
470            @Override
471            public String toString();
472    
473            @Override
474            public String toXmlString();
475    }