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 import java.util.Date; 026 027 /** 028 * The base model interface for the EmailAddress service. Represents a row in the "EmailAddress" database table, with each column mapped to a property of this class. 029 * 030 * <p> 031 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.EmailAddressModelImpl} 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.EmailAddressImpl}. 032 * </p> 033 * 034 * @author Brian Wing Shun Chan 035 * @see EmailAddress 036 * @see com.liferay.portal.model.impl.EmailAddressImpl 037 * @see com.liferay.portal.model.impl.EmailAddressModelImpl 038 * @generated 039 */ 040 public interface EmailAddressModel extends AttachedModel, BaseModel<EmailAddress>, 041 StagedAuditedModel { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. All methods that expect a email address model instance should use the {@link EmailAddress} interface instead. 046 */ 047 048 /** 049 * Returns the primary key of this email address. 050 * 051 * @return the primary key of this email address 052 */ 053 public long getPrimaryKey(); 054 055 /** 056 * Sets the primary key of this email address. 057 * 058 * @param primaryKey the primary key of this email address 059 */ 060 public void setPrimaryKey(long primaryKey); 061 062 /** 063 * Returns the uuid of this email address. 064 * 065 * @return the uuid of this email address 066 */ 067 @AutoEscape 068 @Override 069 public String getUuid(); 070 071 /** 072 * Sets the uuid of this email address. 073 * 074 * @param uuid the uuid of this email address 075 */ 076 @Override 077 public void setUuid(String uuid); 078 079 /** 080 * Returns the email address ID of this email address. 081 * 082 * @return the email address ID of this email address 083 */ 084 public long getEmailAddressId(); 085 086 /** 087 * Sets the email address ID of this email address. 088 * 089 * @param emailAddressId the email address ID of this email address 090 */ 091 public void setEmailAddressId(long emailAddressId); 092 093 /** 094 * Returns the company ID of this email address. 095 * 096 * @return the company ID of this email address 097 */ 098 @Override 099 public long getCompanyId(); 100 101 /** 102 * Sets the company ID of this email address. 103 * 104 * @param companyId the company ID of this email address 105 */ 106 @Override 107 public void setCompanyId(long companyId); 108 109 /** 110 * Returns the user ID of this email address. 111 * 112 * @return the user ID of this email address 113 */ 114 @Override 115 public long getUserId(); 116 117 /** 118 * Sets the user ID of this email address. 119 * 120 * @param userId the user ID of this email address 121 */ 122 @Override 123 public void setUserId(long userId); 124 125 /** 126 * Returns the user uuid of this email address. 127 * 128 * @return the user uuid of this email address 129 * @throws SystemException if a system exception occurred 130 */ 131 @Override 132 public String getUserUuid() throws SystemException; 133 134 /** 135 * Sets the user uuid of this email address. 136 * 137 * @param userUuid the user uuid of this email address 138 */ 139 @Override 140 public void setUserUuid(String userUuid); 141 142 /** 143 * Returns the user name of this email address. 144 * 145 * @return the user name of this email address 146 */ 147 @AutoEscape 148 @Override 149 public String getUserName(); 150 151 /** 152 * Sets the user name of this email address. 153 * 154 * @param userName the user name of this email address 155 */ 156 @Override 157 public void setUserName(String userName); 158 159 /** 160 * Returns the create date of this email address. 161 * 162 * @return the create date of this email address 163 */ 164 @Override 165 public Date getCreateDate(); 166 167 /** 168 * Sets the create date of this email address. 169 * 170 * @param createDate the create date of this email address 171 */ 172 @Override 173 public void setCreateDate(Date createDate); 174 175 /** 176 * Returns the modified date of this email address. 177 * 178 * @return the modified date of this email address 179 */ 180 @Override 181 public Date getModifiedDate(); 182 183 /** 184 * Sets the modified date of this email address. 185 * 186 * @param modifiedDate the modified date of this email address 187 */ 188 @Override 189 public void setModifiedDate(Date modifiedDate); 190 191 /** 192 * Returns the fully qualified class name of this email address. 193 * 194 * @return the fully qualified class name of this email address 195 */ 196 @Override 197 public String getClassName(); 198 199 public void setClassName(String className); 200 201 /** 202 * Returns the class name ID of this email address. 203 * 204 * @return the class name ID of this email address 205 */ 206 @Override 207 public long getClassNameId(); 208 209 /** 210 * Sets the class name ID of this email address. 211 * 212 * @param classNameId the class name ID of this email address 213 */ 214 @Override 215 public void setClassNameId(long classNameId); 216 217 /** 218 * Returns the class p k of this email address. 219 * 220 * @return the class p k of this email address 221 */ 222 @Override 223 public long getClassPK(); 224 225 /** 226 * Sets the class p k of this email address. 227 * 228 * @param classPK the class p k of this email address 229 */ 230 @Override 231 public void setClassPK(long classPK); 232 233 /** 234 * Returns the address of this email address. 235 * 236 * @return the address of this email address 237 */ 238 @AutoEscape 239 public String getAddress(); 240 241 /** 242 * Sets the address of this email address. 243 * 244 * @param address the address of this email address 245 */ 246 public void setAddress(String address); 247 248 /** 249 * Returns the type ID of this email address. 250 * 251 * @return the type ID of this email address 252 */ 253 public int getTypeId(); 254 255 /** 256 * Sets the type ID of this email address. 257 * 258 * @param typeId the type ID of this email address 259 */ 260 public void setTypeId(int typeId); 261 262 /** 263 * Returns the primary of this email address. 264 * 265 * @return the primary of this email address 266 */ 267 public boolean getPrimary(); 268 269 /** 270 * Returns <code>true</code> if this email address is primary. 271 * 272 * @return <code>true</code> if this email address is primary; <code>false</code> otherwise 273 */ 274 public boolean isPrimary(); 275 276 /** 277 * Sets whether this email address is primary. 278 * 279 * @param primary the primary of this email address 280 */ 281 public void setPrimary(boolean primary); 282 283 @Override 284 public boolean isNew(); 285 286 @Override 287 public void setNew(boolean n); 288 289 @Override 290 public boolean isCachedModel(); 291 292 @Override 293 public void setCachedModel(boolean cachedModel); 294 295 @Override 296 public boolean isEscapedModel(); 297 298 @Override 299 public Serializable getPrimaryKeyObj(); 300 301 @Override 302 public void setPrimaryKeyObj(Serializable primaryKeyObj); 303 304 @Override 305 public ExpandoBridge getExpandoBridge(); 306 307 @Override 308 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 309 310 @Override 311 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 312 313 @Override 314 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 315 316 @Override 317 public Object clone(); 318 319 @Override 320 public int compareTo(EmailAddress emailAddress); 321 322 @Override 323 public int hashCode(); 324 325 @Override 326 public CacheModel<EmailAddress> toCacheModel(); 327 328 @Override 329 public EmailAddress toEscapedModel(); 330 331 @Override 332 public EmailAddress toUnescapedModel(); 333 334 @Override 335 public String toString(); 336 337 @Override 338 public String toXmlString(); 339 }