001 /** 002 * Copyright (c) 2000-2010 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.annotation.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 * <p> 033 * Never modify or reference this interface directly. All methods that expect a group model instance should use the {@link Group} interface instead. 034 * </p> 035 * 036 * @author Brian Wing Shun Chan 037 * @see Group 038 * @see com.liferay.portal.model.impl.GroupImpl 039 * @see com.liferay.portal.model.impl.GroupModelImpl 040 * @generated 041 */ 042 public interface GroupModel extends BaseModel<Group> { 043 /** 044 * Gets the primary key of this group. 045 * 046 * @return the primary key of this group 047 */ 048 public long getPrimaryKey(); 049 050 /** 051 * Sets the primary key of this group 052 * 053 * @param pk the primary key of this group 054 */ 055 public void setPrimaryKey(long pk); 056 057 /** 058 * Gets the group id of this group. 059 * 060 * @return the group id of this group 061 */ 062 public long getGroupId(); 063 064 /** 065 * Sets the group id of this group. 066 * 067 * @param groupId the group id of this group 068 */ 069 public void setGroupId(long groupId); 070 071 /** 072 * Gets the company id of this group. 073 * 074 * @return the company id of this group 075 */ 076 public long getCompanyId(); 077 078 /** 079 * Sets the company id of this group. 080 * 081 * @param companyId the company id of this group 082 */ 083 public void setCompanyId(long companyId); 084 085 /** 086 * Gets the creator user id of this group. 087 * 088 * @return the creator user id of this group 089 */ 090 public long getCreatorUserId(); 091 092 /** 093 * Sets the creator user id of this group. 094 * 095 * @param creatorUserId the creator user id of this group 096 */ 097 public void setCreatorUserId(long creatorUserId); 098 099 /** 100 * Gets the creator user uuid of this group. 101 * 102 * @return the creator user uuid of this group 103 * @throws SystemException if a system exception occurred 104 */ 105 public String getCreatorUserUuid() throws SystemException; 106 107 /** 108 * Sets the creator user uuid of this group. 109 * 110 * @param creatorUserUuid the creator user uuid of this group 111 */ 112 public void setCreatorUserUuid(String creatorUserUuid); 113 114 /** 115 * Gets the class name of the model instance this group is polymorphically associated with. 116 * 117 * @return the class name of the model instance this group is polymorphically associated with 118 */ 119 public String getClassName(); 120 121 /** 122 * Gets the class name id of this group. 123 * 124 * @return the class name id of this group 125 */ 126 public long getClassNameId(); 127 128 /** 129 * Sets the class name id of this group. 130 * 131 * @param classNameId the class name id of this group 132 */ 133 public void setClassNameId(long classNameId); 134 135 /** 136 * Gets the class p k of this group. 137 * 138 * @return the class p k of this group 139 */ 140 public long getClassPK(); 141 142 /** 143 * Sets the class p k of this group. 144 * 145 * @param classPK the class p k of this group 146 */ 147 public void setClassPK(long classPK); 148 149 /** 150 * Gets the parent group id of this group. 151 * 152 * @return the parent group id of this group 153 */ 154 public long getParentGroupId(); 155 156 /** 157 * Sets the parent group id of this group. 158 * 159 * @param parentGroupId the parent group id of this group 160 */ 161 public void setParentGroupId(long parentGroupId); 162 163 /** 164 * Gets the live group id of this group. 165 * 166 * @return the live group id of this group 167 */ 168 public long getLiveGroupId(); 169 170 /** 171 * Sets the live group id of this group. 172 * 173 * @param liveGroupId the live group id of this group 174 */ 175 public void setLiveGroupId(long liveGroupId); 176 177 /** 178 * Gets the name of this group. 179 * 180 * @return the name of this group 181 */ 182 @AutoEscape 183 public String getName(); 184 185 /** 186 * Sets the name of this group. 187 * 188 * @param name the name of this group 189 */ 190 public void setName(String name); 191 192 /** 193 * Gets the description of this group. 194 * 195 * @return the description of this group 196 */ 197 @AutoEscape 198 public String getDescription(); 199 200 /** 201 * Sets the description of this group. 202 * 203 * @param description the description of this group 204 */ 205 public void setDescription(String description); 206 207 /** 208 * Gets the type of this group. 209 * 210 * @return the type of this group 211 */ 212 public int getType(); 213 214 /** 215 * Sets the type of this group. 216 * 217 * @param type the type of this group 218 */ 219 public void setType(int type); 220 221 /** 222 * Gets the type settings of this group. 223 * 224 * @return the type settings of this group 225 */ 226 @AutoEscape 227 public String getTypeSettings(); 228 229 /** 230 * Sets the type settings of this group. 231 * 232 * @param typeSettings the type settings of this group 233 */ 234 public void setTypeSettings(String typeSettings); 235 236 /** 237 * Gets the friendly u r l of this group. 238 * 239 * @return the friendly u r l of this group 240 */ 241 @AutoEscape 242 public String getFriendlyURL(); 243 244 /** 245 * Sets the friendly u r l of this group. 246 * 247 * @param friendlyURL the friendly u r l of this group 248 */ 249 public void setFriendlyURL(String friendlyURL); 250 251 /** 252 * Gets the active of this group. 253 * 254 * @return the active of this group 255 */ 256 public boolean getActive(); 257 258 /** 259 * Determines whether this group is active. 260 * 261 * @return whether this group is active 262 */ 263 public boolean isActive(); 264 265 /** 266 * Sets whether this {$entity.humanName} is active. 267 * 268 * @param active the active of this group 269 */ 270 public void setActive(boolean active); 271 272 /** 273 * Gets a copy of this group as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}. 274 * 275 * @return the escaped model instance 276 * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler 277 */ 278 public Group toEscapedModel(); 279 280 public boolean isNew(); 281 282 public void setNew(boolean n); 283 284 public boolean isCachedModel(); 285 286 public void setCachedModel(boolean cachedModel); 287 288 public boolean isEscapedModel(); 289 290 public void setEscapedModel(boolean escapedModel); 291 292 public Serializable getPrimaryKeyObj(); 293 294 public ExpandoBridge getExpandoBridge(); 295 296 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 297 298 public Object clone(); 299 300 public int compareTo(Group group); 301 302 public int hashCode(); 303 304 public String toString(); 305 306 public String toXmlString(); 307 }