001 /** 002 * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 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 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 * <p> 035 * Never modify or reference this interface directly. All methods that expect a email address model instance should use the {@link EmailAddress} interface instead. 036 * </p> 037 * 038 * @author Brian Wing Shun Chan 039 * @see EmailAddress 040 * @see com.liferay.portal.model.impl.EmailAddressImpl 041 * @see com.liferay.portal.model.impl.EmailAddressModelImpl 042 * @generated 043 */ 044 public interface EmailAddressModel extends BaseModel<EmailAddress> { 045 /** 046 * Gets the primary key of this email address. 047 * 048 * @return the primary key of this email address 049 */ 050 public long getPrimaryKey(); 051 052 /** 053 * Sets the primary key of this email address 054 * 055 * @param pk the primary key of this email address 056 */ 057 public void setPrimaryKey(long pk); 058 059 /** 060 * Gets the email address id of this email address. 061 * 062 * @return the email address id of this email address 063 */ 064 public long getEmailAddressId(); 065 066 /** 067 * Sets the email address id of this email address. 068 * 069 * @param emailAddressId the email address id of this email address 070 */ 071 public void setEmailAddressId(long emailAddressId); 072 073 /** 074 * Gets the company id of this email address. 075 * 076 * @return the company id of this email address 077 */ 078 public long getCompanyId(); 079 080 /** 081 * Sets the company id of this email address. 082 * 083 * @param companyId the company id of this email address 084 */ 085 public void setCompanyId(long companyId); 086 087 /** 088 * Gets the user id of this email address. 089 * 090 * @return the user id of this email address 091 */ 092 public long getUserId(); 093 094 /** 095 * Sets the user id of this email address. 096 * 097 * @param userId the user id of this email address 098 */ 099 public void setUserId(long userId); 100 101 /** 102 * Gets the user uuid of this email address. 103 * 104 * @return the user uuid of this email address 105 * @throws SystemException if a system exception occurred 106 */ 107 public String getUserUuid() throws SystemException; 108 109 /** 110 * Sets the user uuid of this email address. 111 * 112 * @param userUuid the user uuid of this email address 113 */ 114 public void setUserUuid(String userUuid); 115 116 /** 117 * Gets the user name of this email address. 118 * 119 * @return the user name of this email address 120 */ 121 @AutoEscape 122 public String getUserName(); 123 124 /** 125 * Sets the user name of this email address. 126 * 127 * @param userName the user name of this email address 128 */ 129 public void setUserName(String userName); 130 131 /** 132 * Gets the create date of this email address. 133 * 134 * @return the create date of this email address 135 */ 136 public Date getCreateDate(); 137 138 /** 139 * Sets the create date of this email address. 140 * 141 * @param createDate the create date of this email address 142 */ 143 public void setCreateDate(Date createDate); 144 145 /** 146 * Gets the modified date of this email address. 147 * 148 * @return the modified date of this email address 149 */ 150 public Date getModifiedDate(); 151 152 /** 153 * Sets the modified date of this email address. 154 * 155 * @param modifiedDate the modified date of this email address 156 */ 157 public void setModifiedDate(Date modifiedDate); 158 159 /** 160 * Gets the class name of the model instance this email address is polymorphically associated with. 161 * 162 * @return the class name of the model instance this email address is polymorphically associated with 163 */ 164 public String getClassName(); 165 166 /** 167 * Gets the class name id of this email address. 168 * 169 * @return the class name id of this email address 170 */ 171 public long getClassNameId(); 172 173 /** 174 * Sets the class name id of this email address. 175 * 176 * @param classNameId the class name id of this email address 177 */ 178 public void setClassNameId(long classNameId); 179 180 /** 181 * Gets the class p k of this email address. 182 * 183 * @return the class p k of this email address 184 */ 185 public long getClassPK(); 186 187 /** 188 * Sets the class p k of this email address. 189 * 190 * @param classPK the class p k of this email address 191 */ 192 public void setClassPK(long classPK); 193 194 /** 195 * Gets the address of this email address. 196 * 197 * @return the address of this email address 198 */ 199 @AutoEscape 200 public String getAddress(); 201 202 /** 203 * Sets the address of this email address. 204 * 205 * @param address the address of this email address 206 */ 207 public void setAddress(String address); 208 209 /** 210 * Gets the type id of this email address. 211 * 212 * @return the type id of this email address 213 */ 214 public int getTypeId(); 215 216 /** 217 * Sets the type id of this email address. 218 * 219 * @param typeId the type id of this email address 220 */ 221 public void setTypeId(int typeId); 222 223 /** 224 * Gets the primary of this email address. 225 * 226 * @return the primary of this email address 227 */ 228 public boolean getPrimary(); 229 230 /** 231 * Determines whether this email address is primary. 232 * 233 * @return whether this email address is primary 234 */ 235 public boolean isPrimary(); 236 237 /** 238 * Sets whether this {$entity.humanName} is primary. 239 * 240 * @param primary the primary of this email address 241 */ 242 public void setPrimary(boolean primary); 243 244 public boolean isNew(); 245 246 public void setNew(boolean n); 247 248 public boolean isCachedModel(); 249 250 public void setCachedModel(boolean cachedModel); 251 252 public boolean isEscapedModel(); 253 254 public void setEscapedModel(boolean escapedModel); 255 256 public Serializable getPrimaryKeyObj(); 257 258 public ExpandoBridge getExpandoBridge(); 259 260 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 261 262 public Object clone(); 263 264 public int compareTo(EmailAddress emailAddress); 265 266 public int hashCode(); 267 268 public EmailAddress toEscapedModel(); 269 270 public String toString(); 271 272 public String toXmlString(); 273 }