001    /**
002     * Copyright (c) 2000-2012 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 group ID of this group.
061             *
062             * @return the group ID of this group
063             */
064            public long getGroupId();
065    
066            /**
067             * Sets the group ID of this group.
068             *
069             * @param groupId the group ID of this group
070             */
071            public void setGroupId(long groupId);
072    
073            /**
074             * Returns the company ID of this group.
075             *
076             * @return the company ID of this group
077             */
078            public long getCompanyId();
079    
080            /**
081             * Sets the company ID of this group.
082             *
083             * @param companyId the company ID of this group
084             */
085            public void setCompanyId(long companyId);
086    
087            /**
088             * Returns the creator user ID of this group.
089             *
090             * @return the creator user ID of this group
091             */
092            public long getCreatorUserId();
093    
094            /**
095             * Sets the creator user ID of this group.
096             *
097             * @param creatorUserId the creator user ID of this group
098             */
099            public void setCreatorUserId(long creatorUserId);
100    
101            /**
102             * Returns the creator user uuid of this group.
103             *
104             * @return the creator user uuid of this group
105             * @throws SystemException if a system exception occurred
106             */
107            public String getCreatorUserUuid() throws SystemException;
108    
109            /**
110             * Sets the creator user uuid of this group.
111             *
112             * @param creatorUserUuid the creator user uuid of this group
113             */
114            public void setCreatorUserUuid(String creatorUserUuid);
115    
116            /**
117             * Returns the fully qualified class name of this group.
118             *
119             * @return the fully qualified class name of this group
120             */
121            public String getClassName();
122    
123            public void setClassName(String className);
124    
125            /**
126             * Returns the class name ID of this group.
127             *
128             * @return the class name ID of this group
129             */
130            public long getClassNameId();
131    
132            /**
133             * Sets the class name ID of this group.
134             *
135             * @param classNameId the class name ID of this group
136             */
137            public void setClassNameId(long classNameId);
138    
139            /**
140             * Returns the class p k of this group.
141             *
142             * @return the class p k of this group
143             */
144            public long getClassPK();
145    
146            /**
147             * Sets the class p k of this group.
148             *
149             * @param classPK the class p k of this group
150             */
151            public void setClassPK(long classPK);
152    
153            /**
154             * Returns the parent group ID of this group.
155             *
156             * @return the parent group ID of this group
157             */
158            public long getParentGroupId();
159    
160            /**
161             * Sets the parent group ID of this group.
162             *
163             * @param parentGroupId the parent group ID of this group
164             */
165            public void setParentGroupId(long parentGroupId);
166    
167            /**
168             * Returns the live group ID of this group.
169             *
170             * @return the live group ID of this group
171             */
172            public long getLiveGroupId();
173    
174            /**
175             * Sets the live group ID of this group.
176             *
177             * @param liveGroupId the live group ID of this group
178             */
179            public void setLiveGroupId(long liveGroupId);
180    
181            /**
182             * Returns the tree path of this group.
183             *
184             * @return the tree path of this group
185             */
186            @AutoEscape
187            public String getTreePath();
188    
189            /**
190             * Sets the tree path of this group.
191             *
192             * @param treePath the tree path of this group
193             */
194            public void setTreePath(String treePath);
195    
196            /**
197             * Returns the name of this group.
198             *
199             * @return the name of this group
200             */
201            @AutoEscape
202            public String getName();
203    
204            /**
205             * Sets the name of this group.
206             *
207             * @param name the name of this group
208             */
209            public void setName(String name);
210    
211            /**
212             * Returns the description of this group.
213             *
214             * @return the description of this group
215             */
216            @AutoEscape
217            public String getDescription();
218    
219            /**
220             * Sets the description of this group.
221             *
222             * @param description the description of this group
223             */
224            public void setDescription(String description);
225    
226            /**
227             * Returns the type of this group.
228             *
229             * @return the type of this group
230             */
231            public int getType();
232    
233            /**
234             * Sets the type of this group.
235             *
236             * @param type the type of this group
237             */
238            public void setType(int type);
239    
240            /**
241             * Returns the type settings of this group.
242             *
243             * @return the type settings of this group
244             */
245            @AutoEscape
246            public String getTypeSettings();
247    
248            /**
249             * Sets the type settings of this group.
250             *
251             * @param typeSettings the type settings of this group
252             */
253            public void setTypeSettings(String typeSettings);
254    
255            /**
256             * Returns the friendly u r l of this group.
257             *
258             * @return the friendly u r l of this group
259             */
260            @AutoEscape
261            public String getFriendlyURL();
262    
263            /**
264             * Sets the friendly u r l of this group.
265             *
266             * @param friendlyURL the friendly u r l of this group
267             */
268            public void setFriendlyURL(String friendlyURL);
269    
270            /**
271             * Returns the site of this group.
272             *
273             * @return the site of this group
274             */
275            public boolean getSite();
276    
277            /**
278             * Returns <code>true</code> if this group is site.
279             *
280             * @return <code>true</code> if this group is site; <code>false</code> otherwise
281             */
282            public boolean isSite();
283    
284            /**
285             * Sets whether this group is site.
286             *
287             * @param site the site of this group
288             */
289            public void setSite(boolean site);
290    
291            /**
292             * Returns the active of this group.
293             *
294             * @return the active of this group
295             */
296            public boolean getActive();
297    
298            /**
299             * Returns <code>true</code> if this group is active.
300             *
301             * @return <code>true</code> if this group is active; <code>false</code> otherwise
302             */
303            public boolean isActive();
304    
305            /**
306             * Sets whether this group is active.
307             *
308             * @param active the active of this group
309             */
310            public void setActive(boolean active);
311    
312            public boolean isNew();
313    
314            public void setNew(boolean n);
315    
316            public boolean isCachedModel();
317    
318            public void setCachedModel(boolean cachedModel);
319    
320            public boolean isEscapedModel();
321    
322            public Serializable getPrimaryKeyObj();
323    
324            public void setPrimaryKeyObj(Serializable primaryKeyObj);
325    
326            public ExpandoBridge getExpandoBridge();
327    
328            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
329    
330            public Object clone();
331    
332            public int compareTo(Group group);
333    
334            public int hashCode();
335    
336            public CacheModel<Group> toCacheModel();
337    
338            public Group toEscapedModel();
339    
340            public Group toUnescapedModel();
341    
342            public String toString();
343    
344            public String toXmlString();
345    }