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>, StagedModel {
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            public String getUuid();
068    
069            /**
070             * Sets the uuid of this user group.
071             *
072             * @param uuid the uuid of this user group
073             */
074            public void setUuid(String uuid);
075    
076            /**
077             * Returns the user group ID of this user group.
078             *
079             * @return the user group ID of this user group
080             */
081            public long getUserGroupId();
082    
083            /**
084             * Sets the user group ID of this user group.
085             *
086             * @param userGroupId the user group ID of this user group
087             */
088            public void setUserGroupId(long userGroupId);
089    
090            /**
091             * Returns the company ID of this user group.
092             *
093             * @return the company ID of this user group
094             */
095            public long getCompanyId();
096    
097            /**
098             * Sets the company ID of this user group.
099             *
100             * @param companyId the company ID of this user group
101             */
102            public void setCompanyId(long companyId);
103    
104            /**
105             * Returns the user ID of this user group.
106             *
107             * @return the user ID of this user group
108             */
109            public long getUserId();
110    
111            /**
112             * Sets the user ID of this user group.
113             *
114             * @param userId the user ID of this user group
115             */
116            public void setUserId(long userId);
117    
118            /**
119             * Returns the user uuid of this user group.
120             *
121             * @return the user uuid of this user group
122             * @throws SystemException if a system exception occurred
123             */
124            public String getUserUuid() throws SystemException;
125    
126            /**
127             * Sets the user uuid of this user group.
128             *
129             * @param userUuid the user uuid of this user group
130             */
131            public void setUserUuid(String userUuid);
132    
133            /**
134             * Returns the user name of this user group.
135             *
136             * @return the user name of this user group
137             */
138            @AutoEscape
139            public String getUserName();
140    
141            /**
142             * Sets the user name of this user group.
143             *
144             * @param userName the user name of this user group
145             */
146            public void setUserName(String userName);
147    
148            /**
149             * Returns the create date of this user group.
150             *
151             * @return the create date of this user group
152             */
153            public Date getCreateDate();
154    
155            /**
156             * Sets the create date of this user group.
157             *
158             * @param createDate the create date of this user group
159             */
160            public void setCreateDate(Date createDate);
161    
162            /**
163             * Returns the modified date of this user group.
164             *
165             * @return the modified date of this user group
166             */
167            public Date getModifiedDate();
168    
169            /**
170             * Sets the modified date of this user group.
171             *
172             * @param modifiedDate the modified date of this user group
173             */
174            public void setModifiedDate(Date modifiedDate);
175    
176            /**
177             * Returns the parent user group ID of this user group.
178             *
179             * @return the parent user group ID of this user group
180             */
181            public long getParentUserGroupId();
182    
183            /**
184             * Sets the parent user group ID of this user group.
185             *
186             * @param parentUserGroupId the parent user group ID of this user group
187             */
188            public void setParentUserGroupId(long parentUserGroupId);
189    
190            /**
191             * Returns the name of this user group.
192             *
193             * @return the name of this user group
194             */
195            @AutoEscape
196            public String getName();
197    
198            /**
199             * Sets the name of this user group.
200             *
201             * @param name the name of this user group
202             */
203            public void setName(String name);
204    
205            /**
206             * Returns the description of this user group.
207             *
208             * @return the description of this user group
209             */
210            @AutoEscape
211            public String getDescription();
212    
213            /**
214             * Sets the description of this user group.
215             *
216             * @param description the description of this user group
217             */
218            public void setDescription(String description);
219    
220            /**
221             * Returns the added by l d a p import of this user group.
222             *
223             * @return the added by l d a p import of this user group
224             */
225            public boolean getAddedByLDAPImport();
226    
227            /**
228             * Returns <code>true</code> if this user group is added by l d a p import.
229             *
230             * @return <code>true</code> if this user group is added by l d a p import; <code>false</code> otherwise
231             */
232            public boolean isAddedByLDAPImport();
233    
234            /**
235             * Sets whether this user group is added by l d a p import.
236             *
237             * @param addedByLDAPImport the added by l d a p import of this user group
238             */
239            public void setAddedByLDAPImport(boolean addedByLDAPImport);
240    
241            public boolean isNew();
242    
243            public void setNew(boolean n);
244    
245            public boolean isCachedModel();
246    
247            public void setCachedModel(boolean cachedModel);
248    
249            public boolean isEscapedModel();
250    
251            public Serializable getPrimaryKeyObj();
252    
253            public void setPrimaryKeyObj(Serializable primaryKeyObj);
254    
255            public ExpandoBridge getExpandoBridge();
256    
257            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
258    
259            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
260    
261            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
262    
263            public Object clone();
264    
265            public int compareTo(UserGroup userGroup);
266    
267            public int hashCode();
268    
269            public CacheModel<UserGroup> toCacheModel();
270    
271            public UserGroup toEscapedModel();
272    
273            public UserGroup toUnescapedModel();
274    
275            public String toString();
276    
277            public String toXmlString();
278    }