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