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 /** 026 * The base model interface for the Group service. Represents a row in the "Group_" database table, with each column mapped to a property of this class. 027 * 028 * <p> 029 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.GroupModelImpl} 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.GroupImpl}. 030 * </p> 031 * 032 * @author Brian Wing Shun Chan 033 * @see Group 034 * @see com.liferay.portal.model.impl.GroupImpl 035 * @see com.liferay.portal.model.impl.GroupModelImpl 036 * @generated 037 */ 038 public interface GroupModel extends AttachedModel, BaseModel<Group> { 039 /* 040 * NOTE FOR DEVELOPERS: 041 * 042 * Never modify or reference this interface directly. All methods that expect a group model instance should use the {@link Group} interface instead. 043 */ 044 045 /** 046 * Returns the primary key of this group. 047 * 048 * @return the primary key of this group 049 */ 050 public long getPrimaryKey(); 051 052 /** 053 * Sets the primary key of this group. 054 * 055 * @param primaryKey the primary key of this group 056 */ 057 public void setPrimaryKey(long primaryKey); 058 059 /** 060 * Returns the uuid of this group. 061 * 062 * @return the uuid of this group 063 */ 064 @AutoEscape 065 public String getUuid(); 066 067 /** 068 * Sets the uuid of this group. 069 * 070 * @param uuid the uuid of this group 071 */ 072 public void setUuid(String uuid); 073 074 /** 075 * Returns the group ID of this group. 076 * 077 * @return the group ID of this group 078 */ 079 public long getGroupId(); 080 081 /** 082 * Sets the group ID of this group. 083 * 084 * @param groupId the group ID of this group 085 */ 086 public void setGroupId(long groupId); 087 088 /** 089 * Returns the company ID of this group. 090 * 091 * @return the company ID of this group 092 */ 093 public long getCompanyId(); 094 095 /** 096 * Sets the company ID of this group. 097 * 098 * @param companyId the company ID of this group 099 */ 100 public void setCompanyId(long companyId); 101 102 /** 103 * Returns the creator user ID of this group. 104 * 105 * @return the creator user ID of this group 106 */ 107 public long getCreatorUserId(); 108 109 /** 110 * Sets the creator user ID of this group. 111 * 112 * @param creatorUserId the creator user ID of this group 113 */ 114 public void setCreatorUserId(long creatorUserId); 115 116 /** 117 * Returns the creator user uuid of this group. 118 * 119 * @return the creator user uuid of this group 120 * @throws SystemException if a system exception occurred 121 */ 122 public String getCreatorUserUuid() throws SystemException; 123 124 /** 125 * Sets the creator user uuid of this group. 126 * 127 * @param creatorUserUuid the creator user uuid of this group 128 */ 129 public void setCreatorUserUuid(String creatorUserUuid); 130 131 /** 132 * Returns the fully qualified class name of this group. 133 * 134 * @return the fully qualified class name of this group 135 */ 136 public String getClassName(); 137 138 public void setClassName(String className); 139 140 /** 141 * Returns the class name ID of this group. 142 * 143 * @return the class name ID of this group 144 */ 145 public long getClassNameId(); 146 147 /** 148 * Sets the class name ID of this group. 149 * 150 * @param classNameId the class name ID of this group 151 */ 152 public void setClassNameId(long classNameId); 153 154 /** 155 * Returns the class p k of this group. 156 * 157 * @return the class p k of this group 158 */ 159 public long getClassPK(); 160 161 /** 162 * Sets the class p k of this group. 163 * 164 * @param classPK the class p k of this group 165 */ 166 public void setClassPK(long classPK); 167 168 /** 169 * Returns the parent group ID of this group. 170 * 171 * @return the parent group ID of this group 172 */ 173 public long getParentGroupId(); 174 175 /** 176 * Sets the parent group ID of this group. 177 * 178 * @param parentGroupId the parent group ID of this group 179 */ 180 public void setParentGroupId(long parentGroupId); 181 182 /** 183 * Returns the live group ID of this group. 184 * 185 * @return the live group ID of this group 186 */ 187 public long getLiveGroupId(); 188 189 /** 190 * Sets the live group ID of this group. 191 * 192 * @param liveGroupId the live group ID of this group 193 */ 194 public void setLiveGroupId(long liveGroupId); 195 196 /** 197 * Returns the tree path of this group. 198 * 199 * @return the tree path of this group 200 */ 201 @AutoEscape 202 public String getTreePath(); 203 204 /** 205 * Sets the tree path of this group. 206 * 207 * @param treePath the tree path of this group 208 */ 209 public void setTreePath(String treePath); 210 211 /** 212 * Returns the name of this group. 213 * 214 * @return the name of this group 215 */ 216 @AutoEscape 217 public String getName(); 218 219 /** 220 * Sets the name of this group. 221 * 222 * @param name the name of this group 223 */ 224 public void setName(String name); 225 226 /** 227 * Returns the description of this group. 228 * 229 * @return the description of this group 230 */ 231 @AutoEscape 232 public String getDescription(); 233 234 /** 235 * Sets the description of this group. 236 * 237 * @param description the description of this group 238 */ 239 public void setDescription(String description); 240 241 /** 242 * Returns the type of this group. 243 * 244 * @return the type of this group 245 */ 246 public int getType(); 247 248 /** 249 * Sets the type of this group. 250 * 251 * @param type the type of this group 252 */ 253 public void setType(int type); 254 255 /** 256 * Returns the type settings of this group. 257 * 258 * @return the type settings of this group 259 */ 260 @AutoEscape 261 public String getTypeSettings(); 262 263 /** 264 * Sets the type settings of this group. 265 * 266 * @param typeSettings the type settings of this group 267 */ 268 public void setTypeSettings(String typeSettings); 269 270 /** 271 * Returns the friendly u r l of this group. 272 * 273 * @return the friendly u r l of this group 274 */ 275 @AutoEscape 276 public String getFriendlyURL(); 277 278 /** 279 * Sets the friendly u r l of this group. 280 * 281 * @param friendlyURL the friendly u r l of this group 282 */ 283 public void setFriendlyURL(String friendlyURL); 284 285 /** 286 * Returns the site of this group. 287 * 288 * @return the site of this group 289 */ 290 public boolean getSite(); 291 292 /** 293 * Returns <code>true</code> if this group is site. 294 * 295 * @return <code>true</code> if this group is site; <code>false</code> otherwise 296 */ 297 public boolean isSite(); 298 299 /** 300 * Sets whether this group is site. 301 * 302 * @param site the site of this group 303 */ 304 public void setSite(boolean site); 305 306 /** 307 * Returns the active of this group. 308 * 309 * @return the active of this group 310 */ 311 public boolean getActive(); 312 313 /** 314 * Returns <code>true</code> if this group is active. 315 * 316 * @return <code>true</code> if this group is active; <code>false</code> otherwise 317 */ 318 public boolean isActive(); 319 320 /** 321 * Sets whether this group is active. 322 * 323 * @param active the active of this group 324 */ 325 public void setActive(boolean active); 326 327 public boolean isNew(); 328 329 public void setNew(boolean n); 330 331 public boolean isCachedModel(); 332 333 public void setCachedModel(boolean cachedModel); 334 335 public boolean isEscapedModel(); 336 337 public Serializable getPrimaryKeyObj(); 338 339 public void setPrimaryKeyObj(Serializable primaryKeyObj); 340 341 public ExpandoBridge getExpandoBridge(); 342 343 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 344 345 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 346 347 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 348 349 public Object clone(); 350 351 public int compareTo(Group group); 352 353 public int hashCode(); 354 355 public CacheModel<Group> toCacheModel(); 356 357 public Group toEscapedModel(); 358 359 public Group toUnescapedModel(); 360 361 public String toString(); 362 363 public String toXmlString(); 364 }