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            /**
124             * Returns the class name ID of this group.
125             *
126             * @return the class name ID of this group
127             */
128            public long getClassNameId();
129    
130            /**
131             * Sets the class name ID of this group.
132             *
133             * @param classNameId the class name ID of this group
134             */
135            public void setClassNameId(long classNameId);
136    
137            /**
138             * Returns the class p k of this group.
139             *
140             * @return the class p k of this group
141             */
142            public long getClassPK();
143    
144            /**
145             * Sets the class p k of this group.
146             *
147             * @param classPK the class p k of this group
148             */
149            public void setClassPK(long classPK);
150    
151            /**
152             * Returns the parent group ID of this group.
153             *
154             * @return the parent group ID of this group
155             */
156            public long getParentGroupId();
157    
158            /**
159             * Sets the parent group ID of this group.
160             *
161             * @param parentGroupId the parent group ID of this group
162             */
163            public void setParentGroupId(long parentGroupId);
164    
165            /**
166             * Returns the live group ID of this group.
167             *
168             * @return the live group ID of this group
169             */
170            public long getLiveGroupId();
171    
172            /**
173             * Sets the live group ID of this group.
174             *
175             * @param liveGroupId the live group ID of this group
176             */
177            public void setLiveGroupId(long liveGroupId);
178    
179            /**
180             * Returns the name of this group.
181             *
182             * @return the name of this group
183             */
184            @AutoEscape
185            public String getName();
186    
187            /**
188             * Sets the name of this group.
189             *
190             * @param name the name of this group
191             */
192            public void setName(String name);
193    
194            /**
195             * Returns the description of this group.
196             *
197             * @return the description of this group
198             */
199            @AutoEscape
200            public String getDescription();
201    
202            /**
203             * Sets the description of this group.
204             *
205             * @param description the description of this group
206             */
207            public void setDescription(String description);
208    
209            /**
210             * Returns the type of this group.
211             *
212             * @return the type of this group
213             */
214            public int getType();
215    
216            /**
217             * Sets the type of this group.
218             *
219             * @param type the type of this group
220             */
221            public void setType(int type);
222    
223            /**
224             * Returns the type settings of this group.
225             *
226             * @return the type settings of this group
227             */
228            @AutoEscape
229            public String getTypeSettings();
230    
231            /**
232             * Sets the type settings of this group.
233             *
234             * @param typeSettings the type settings of this group
235             */
236            public void setTypeSettings(String typeSettings);
237    
238            /**
239             * Returns the friendly u r l of this group.
240             *
241             * @return the friendly u r l of this group
242             */
243            @AutoEscape
244            public String getFriendlyURL();
245    
246            /**
247             * Sets the friendly u r l of this group.
248             *
249             * @param friendlyURL the friendly u r l of this group
250             */
251            public void setFriendlyURL(String friendlyURL);
252    
253            /**
254             * Returns the site of this group.
255             *
256             * @return the site of this group
257             */
258            public boolean getSite();
259    
260            /**
261             * Returns <code>true</code> if this group is site.
262             *
263             * @return <code>true</code> if this group is site; <code>false</code> otherwise
264             */
265            public boolean isSite();
266    
267            /**
268             * Sets whether this group is site.
269             *
270             * @param site the site of this group
271             */
272            public void setSite(boolean site);
273    
274            /**
275             * Returns the active of this group.
276             *
277             * @return the active of this group
278             */
279            public boolean getActive();
280    
281            /**
282             * Returns <code>true</code> if this group is active.
283             *
284             * @return <code>true</code> if this group is active; <code>false</code> otherwise
285             */
286            public boolean isActive();
287    
288            /**
289             * Sets whether this group is active.
290             *
291             * @param active the active of this group
292             */
293            public void setActive(boolean active);
294    
295            public boolean isNew();
296    
297            public void setNew(boolean n);
298    
299            public boolean isCachedModel();
300    
301            public void setCachedModel(boolean cachedModel);
302    
303            public boolean isEscapedModel();
304    
305            public Serializable getPrimaryKeyObj();
306    
307            public void setPrimaryKeyObj(Serializable primaryKeyObj);
308    
309            public ExpandoBridge getExpandoBridge();
310    
311            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
312    
313            public Object clone();
314    
315            public int compareTo(Group group);
316    
317            public int hashCode();
318    
319            public CacheModel<Group> toCacheModel();
320    
321            public Group toEscapedModel();
322    
323            public String toString();
324    
325            public String toXmlString();
326    }