001 /** 002 * Copyright (c) 2000-present 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.service.ServiceContext; 021 022 import com.liferay.portlet.expando.model.ExpandoBridge; 023 024 import java.io.Serializable; 025 026 import java.util.Date; 027 028 /** 029 * 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. 030 * 031 * <p> 032 * 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}. 033 * </p> 034 * 035 * @author Brian Wing Shun Chan 036 * @see UserGroup 037 * @see com.liferay.portal.model.impl.UserGroupImpl 038 * @see com.liferay.portal.model.impl.UserGroupModelImpl 039 * @generated 040 */ 041 @ProviderType 042 public interface UserGroupModel extends BaseModel<UserGroup>, MVCCModel, 043 ShardedModel, 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 mvcc version of this user group. 066 * 067 * @return the mvcc version of this user group 068 */ 069 @Override 070 public long getMvccVersion(); 071 072 /** 073 * Sets the mvcc version of this user group. 074 * 075 * @param mvccVersion the mvcc version of this user group 076 */ 077 @Override 078 public void setMvccVersion(long mvccVersion); 079 080 /** 081 * Returns the uuid of this user group. 082 * 083 * @return the uuid of this user group 084 */ 085 @AutoEscape 086 @Override 087 public String getUuid(); 088 089 /** 090 * Sets the uuid of this user group. 091 * 092 * @param uuid the uuid of this user group 093 */ 094 @Override 095 public void setUuid(String uuid); 096 097 /** 098 * Returns the user group ID of this user group. 099 * 100 * @return the user group ID of this user group 101 */ 102 public long getUserGroupId(); 103 104 /** 105 * Sets the user group ID of this user group. 106 * 107 * @param userGroupId the user group ID of this user group 108 */ 109 public void setUserGroupId(long userGroupId); 110 111 /** 112 * Returns the company ID of this user group. 113 * 114 * @return the company ID of this user group 115 */ 116 @Override 117 public long getCompanyId(); 118 119 /** 120 * Sets the company ID of this user group. 121 * 122 * @param companyId the company ID of this user group 123 */ 124 @Override 125 public void setCompanyId(long companyId); 126 127 /** 128 * Returns the user ID of this user group. 129 * 130 * @return the user ID of this user group 131 */ 132 @Override 133 public long getUserId(); 134 135 /** 136 * Sets the user ID of this user group. 137 * 138 * @param userId the user ID of this user group 139 */ 140 @Override 141 public void setUserId(long userId); 142 143 /** 144 * Returns the user uuid of this user group. 145 * 146 * @return the user uuid of this user group 147 */ 148 @Override 149 public String getUserUuid(); 150 151 /** 152 * Sets the user uuid of this user group. 153 * 154 * @param userUuid the user uuid of this user group 155 */ 156 @Override 157 public void setUserUuid(String userUuid); 158 159 /** 160 * Returns the user name of this user group. 161 * 162 * @return the user name of this user group 163 */ 164 @AutoEscape 165 @Override 166 public String getUserName(); 167 168 /** 169 * Sets the user name of this user group. 170 * 171 * @param userName the user name of this user group 172 */ 173 @Override 174 public void setUserName(String userName); 175 176 /** 177 * Returns the create date of this user group. 178 * 179 * @return the create date of this user group 180 */ 181 @Override 182 public Date getCreateDate(); 183 184 /** 185 * Sets the create date of this user group. 186 * 187 * @param createDate the create date of this user group 188 */ 189 @Override 190 public void setCreateDate(Date createDate); 191 192 /** 193 * Returns the modified date of this user group. 194 * 195 * @return the modified date of this user group 196 */ 197 @Override 198 public Date getModifiedDate(); 199 200 /** 201 * Sets the modified date of this user group. 202 * 203 * @param modifiedDate the modified date of this user group 204 */ 205 @Override 206 public void setModifiedDate(Date modifiedDate); 207 208 /** 209 * Returns the parent user group ID of this user group. 210 * 211 * @return the parent user group ID of this user group 212 */ 213 public long getParentUserGroupId(); 214 215 /** 216 * Sets the parent user group ID of this user group. 217 * 218 * @param parentUserGroupId the parent user group ID of this user group 219 */ 220 public void setParentUserGroupId(long parentUserGroupId); 221 222 /** 223 * Returns the name of this user group. 224 * 225 * @return the name of this user group 226 */ 227 @AutoEscape 228 public String getName(); 229 230 /** 231 * Sets the name of this user group. 232 * 233 * @param name the name of this user group 234 */ 235 public void setName(String name); 236 237 /** 238 * Returns the description of this user group. 239 * 240 * @return the description of this user group 241 */ 242 @AutoEscape 243 public String getDescription(); 244 245 /** 246 * Sets the description of this user group. 247 * 248 * @param description the description of this user group 249 */ 250 public void setDescription(String description); 251 252 /** 253 * Returns the added by l d a p import of this user group. 254 * 255 * @return the added by l d a p import of this user group 256 */ 257 public boolean getAddedByLDAPImport(); 258 259 /** 260 * Returns <code>true</code> if this user group is added by l d a p import. 261 * 262 * @return <code>true</code> if this user group is added by l d a p import; <code>false</code> otherwise 263 */ 264 public boolean isAddedByLDAPImport(); 265 266 /** 267 * Sets whether this user group is added by l d a p import. 268 * 269 * @param addedByLDAPImport the added by l d a p import of this user group 270 */ 271 public void setAddedByLDAPImport(boolean addedByLDAPImport); 272 273 /** 274 * Returns the last publish date of this user group. 275 * 276 * @return the last publish date of this user group 277 */ 278 public Date getLastPublishDate(); 279 280 /** 281 * Sets the last publish date of this user group. 282 * 283 * @param lastPublishDate the last publish date of this user group 284 */ 285 public void setLastPublishDate(Date lastPublishDate); 286 287 @Override 288 public boolean isNew(); 289 290 @Override 291 public void setNew(boolean n); 292 293 @Override 294 public boolean isCachedModel(); 295 296 @Override 297 public void setCachedModel(boolean cachedModel); 298 299 @Override 300 public boolean isEscapedModel(); 301 302 @Override 303 public Serializable getPrimaryKeyObj(); 304 305 @Override 306 public void setPrimaryKeyObj(Serializable primaryKeyObj); 307 308 @Override 309 public ExpandoBridge getExpandoBridge(); 310 311 @Override 312 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 313 314 @Override 315 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 316 317 @Override 318 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 319 320 @Override 321 public Object clone(); 322 323 @Override 324 public int compareTo(com.liferay.portal.model.UserGroup userGroup); 325 326 @Override 327 public int hashCode(); 328 329 @Override 330 public CacheModel<com.liferay.portal.model.UserGroup> toCacheModel(); 331 332 @Override 333 public com.liferay.portal.model.UserGroup toEscapedModel(); 334 335 @Override 336 public com.liferay.portal.model.UserGroup toUnescapedModel(); 337 338 @Override 339 public String toString(); 340 341 @Override 342 public String toXmlString(); 343 }