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    import java.util.Date;
026    
027    /**
028     * The base model interface for the UserGroup service. Represents a row in the "UserGroup" 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.UserGroupModelImpl} 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.UserGroupImpl}.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see UserGroup
036     * @see com.liferay.portal.model.impl.UserGroupImpl
037     * @see com.liferay.portal.model.impl.UserGroupModelImpl
038     * @generated
039     */
040    public interface UserGroupModel extends BaseModel<UserGroup>, StagedAuditedModel {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. All methods that expect a user group model instance should use the {@link UserGroup} interface instead.
045             */
046    
047            /**
048             * Returns the primary key of this user group.
049             *
050             * @return the primary key of this user group
051             */
052            public long getPrimaryKey();
053    
054            /**
055             * Sets the primary key of this user group.
056             *
057             * @param primaryKey the primary key of this user group
058             */
059            public void setPrimaryKey(long primaryKey);
060    
061            /**
062             * Returns the uuid of this user group.
063             *
064             * @return the uuid of this user group
065             */
066            @AutoEscape
067            @Override
068            public String getUuid();
069    
070            /**
071             * Sets the uuid of this user group.
072             *
073             * @param uuid the uuid of this user group
074             */
075            @Override
076            public void setUuid(String uuid);
077    
078            /**
079             * Returns the user group ID of this user group.
080             *
081             * @return the user group ID of this user group
082             */
083            public long getUserGroupId();
084    
085            /**
086             * Sets the user group ID of this user group.
087             *
088             * @param userGroupId the user group ID of this user group
089             */
090            public void setUserGroupId(long userGroupId);
091    
092            /**
093             * Returns the company ID of this user group.
094             *
095             * @return the company ID of this user group
096             */
097            @Override
098            public long getCompanyId();
099    
100            /**
101             * Sets the company ID of this user group.
102             *
103             * @param companyId the company ID of this user group
104             */
105            @Override
106            public void setCompanyId(long companyId);
107    
108            /**
109             * Returns the user ID of this user group.
110             *
111             * @return the user ID of this user group
112             */
113            @Override
114            public long getUserId();
115    
116            /**
117             * Sets the user ID of this user group.
118             *
119             * @param userId the user ID of this user group
120             */
121            @Override
122            public void setUserId(long userId);
123    
124            /**
125             * Returns the user uuid of this user group.
126             *
127             * @return the user uuid of this user group
128             * @throws SystemException if a system exception occurred
129             */
130            @Override
131            public String getUserUuid() throws SystemException;
132    
133            /**
134             * Sets the user uuid of this user group.
135             *
136             * @param userUuid the user uuid of this user group
137             */
138            @Override
139            public void setUserUuid(String userUuid);
140    
141            /**
142             * Returns the user name of this user group.
143             *
144             * @return the user name of this user group
145             */
146            @AutoEscape
147            @Override
148            public String getUserName();
149    
150            /**
151             * Sets the user name of this user group.
152             *
153             * @param userName the user name of this user group
154             */
155            @Override
156            public void setUserName(String userName);
157    
158            /**
159             * Returns the create date of this user group.
160             *
161             * @return the create date of this user group
162             */
163            @Override
164            public Date getCreateDate();
165    
166            /**
167             * Sets the create date of this user group.
168             *
169             * @param createDate the create date of this user group
170             */
171            @Override
172            public void setCreateDate(Date createDate);
173    
174            /**
175             * Returns the modified date of this user group.
176             *
177             * @return the modified date of this user group
178             */
179            @Override
180            public Date getModifiedDate();
181    
182            /**
183             * Sets the modified date of this user group.
184             *
185             * @param modifiedDate the modified date of this user group
186             */
187            @Override
188            public void setModifiedDate(Date modifiedDate);
189    
190            /**
191             * Returns the parent user group ID of this user group.
192             *
193             * @return the parent user group ID of this user group
194             */
195            public long getParentUserGroupId();
196    
197            /**
198             * Sets the parent user group ID of this user group.
199             *
200             * @param parentUserGroupId the parent user group ID of this user group
201             */
202            public void setParentUserGroupId(long parentUserGroupId);
203    
204            /**
205             * Returns the name of this user group.
206             *
207             * @return the name of this user group
208             */
209            @AutoEscape
210            public String getName();
211    
212            /**
213             * Sets the name of this user group.
214             *
215             * @param name the name of this user group
216             */
217            public void setName(String name);
218    
219            /**
220             * Returns the description of this user group.
221             *
222             * @return the description of this user group
223             */
224            @AutoEscape
225            public String getDescription();
226    
227            /**
228             * Sets the description of this user group.
229             *
230             * @param description the description of this user group
231             */
232            public void setDescription(String description);
233    
234            /**
235             * Returns the added by l d a p import of this user group.
236             *
237             * @return the added by l d a p import of this user group
238             */
239            public boolean getAddedByLDAPImport();
240    
241            /**
242             * Returns <code>true</code> if this user group is added by l d a p import.
243             *
244             * @return <code>true</code> if this user group is added by l d a p import; <code>false</code> otherwise
245             */
246            public boolean isAddedByLDAPImport();
247    
248            /**
249             * Sets whether this user group is added by l d a p import.
250             *
251             * @param addedByLDAPImport the added by l d a p import of this user group
252             */
253            public void setAddedByLDAPImport(boolean addedByLDAPImport);
254    
255            @Override
256            public boolean isNew();
257    
258            @Override
259            public void setNew(boolean n);
260    
261            @Override
262            public boolean isCachedModel();
263    
264            @Override
265            public void setCachedModel(boolean cachedModel);
266    
267            @Override
268            public boolean isEscapedModel();
269    
270            @Override
271            public Serializable getPrimaryKeyObj();
272    
273            @Override
274            public void setPrimaryKeyObj(Serializable primaryKeyObj);
275    
276            @Override
277            public ExpandoBridge getExpandoBridge();
278    
279            @Override
280            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
281    
282            @Override
283            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
284    
285            @Override
286            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
287    
288            @Override
289            public Object clone();
290    
291            @Override
292            public int compareTo(UserGroup userGroup);
293    
294            @Override
295            public int hashCode();
296    
297            @Override
298            public CacheModel<UserGroup> toCacheModel();
299    
300            @Override
301            public UserGroup toEscapedModel();
302    
303            @Override
304            public UserGroup toUnescapedModel();
305    
306            @Override
307            public String toString();
308    
309            @Override
310            public String toXmlString();
311    }