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.service.ServiceContext;
019    
020    import com.liferay.portlet.expando.model.ExpandoBridge;
021    
022    import java.io.Serializable;
023    
024    /**
025     * 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.
026     *
027     * <p>
028     * 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}.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see UserGroup
033     * @see com.liferay.portal.model.impl.UserGroupImpl
034     * @see com.liferay.portal.model.impl.UserGroupModelImpl
035     * @generated
036     */
037    public interface UserGroupModel extends BaseModel<UserGroup> {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify or reference this interface directly. All methods that expect a user group model instance should use the {@link UserGroup} interface instead.
042             */
043    
044            /**
045             * Returns the primary key of this user group.
046             *
047             * @return the primary key of this user group
048             */
049            public long getPrimaryKey();
050    
051            /**
052             * Sets the primary key of this user group.
053             *
054             * @param primaryKey the primary key of this user group
055             */
056            public void setPrimaryKey(long primaryKey);
057    
058            /**
059             * Returns the user group ID of this user group.
060             *
061             * @return the user group ID of this user group
062             */
063            public long getUserGroupId();
064    
065            /**
066             * Sets the user group ID of this user group.
067             *
068             * @param userGroupId the user group ID of this user group
069             */
070            public void setUserGroupId(long userGroupId);
071    
072            /**
073             * Returns the company ID of this user group.
074             *
075             * @return the company ID of this user group
076             */
077            public long getCompanyId();
078    
079            /**
080             * Sets the company ID of this user group.
081             *
082             * @param companyId the company ID of this user group
083             */
084            public void setCompanyId(long companyId);
085    
086            /**
087             * Returns the parent user group ID of this user group.
088             *
089             * @return the parent user group ID of this user group
090             */
091            public long getParentUserGroupId();
092    
093            /**
094             * Sets the parent user group ID of this user group.
095             *
096             * @param parentUserGroupId the parent user group ID of this user group
097             */
098            public void setParentUserGroupId(long parentUserGroupId);
099    
100            /**
101             * Returns the name of this user group.
102             *
103             * @return the name of this user group
104             */
105            @AutoEscape
106            public String getName();
107    
108            /**
109             * Sets the name of this user group.
110             *
111             * @param name the name of this user group
112             */
113            public void setName(String name);
114    
115            /**
116             * Returns the description of this user group.
117             *
118             * @return the description of this user group
119             */
120            @AutoEscape
121            public String getDescription();
122    
123            /**
124             * Sets the description of this user group.
125             *
126             * @param description the description of this user group
127             */
128            public void setDescription(String description);
129    
130            /**
131             * Returns the added by l d a p import of this user group.
132             *
133             * @return the added by l d a p import of this user group
134             */
135            public boolean getAddedByLDAPImport();
136    
137            /**
138             * Returns <code>true</code> if this user group is added by l d a p import.
139             *
140             * @return <code>true</code> if this user group is added by l d a p import; <code>false</code> otherwise
141             */
142            public boolean isAddedByLDAPImport();
143    
144            /**
145             * Sets whether this user group is added by l d a p import.
146             *
147             * @param addedByLDAPImport the added by l d a p import of this user group
148             */
149            public void setAddedByLDAPImport(boolean addedByLDAPImport);
150    
151            public boolean isNew();
152    
153            public void setNew(boolean n);
154    
155            public boolean isCachedModel();
156    
157            public void setCachedModel(boolean cachedModel);
158    
159            public boolean isEscapedModel();
160    
161            public Serializable getPrimaryKeyObj();
162    
163            public void setPrimaryKeyObj(Serializable primaryKeyObj);
164    
165            public ExpandoBridge getExpandoBridge();
166    
167            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
168    
169            public Object clone();
170    
171            public int compareTo(UserGroup userGroup);
172    
173            public int hashCode();
174    
175            public CacheModel<UserGroup> toCacheModel();
176    
177            public UserGroup toEscapedModel();
178    
179            public UserGroup toUnescapedModel();
180    
181            public String toString();
182    
183            public String toXmlString();
184    }