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