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