001    /**
002     * Copyright (c) 2000-2012 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, AuditedModel,
041            BaseModel<EmailAddress> {
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 email address ID of this email address.
064             *
065             * @return the email address ID of this email address
066             */
067            public long getEmailAddressId();
068    
069            /**
070             * Sets the email address ID of this email address.
071             *
072             * @param emailAddressId the email address ID of this email address
073             */
074            public void setEmailAddressId(long emailAddressId);
075    
076            /**
077             * Returns the company ID of this email address.
078             *
079             * @return the company ID of this email address
080             */
081            public long getCompanyId();
082    
083            /**
084             * Sets the company ID of this email address.
085             *
086             * @param companyId the company ID of this email address
087             */
088            public void setCompanyId(long companyId);
089    
090            /**
091             * Returns the user ID of this email address.
092             *
093             * @return the user ID of this email address
094             */
095            public long getUserId();
096    
097            /**
098             * Sets the user ID of this email address.
099             *
100             * @param userId the user ID of this email address
101             */
102            public void setUserId(long userId);
103    
104            /**
105             * Returns the user uuid of this email address.
106             *
107             * @return the user uuid of this email address
108             * @throws SystemException if a system exception occurred
109             */
110            public String getUserUuid() throws SystemException;
111    
112            /**
113             * Sets the user uuid of this email address.
114             *
115             * @param userUuid the user uuid of this email address
116             */
117            public void setUserUuid(String userUuid);
118    
119            /**
120             * Returns the user name of this email address.
121             *
122             * @return the user name of this email address
123             */
124            @AutoEscape
125            public String getUserName();
126    
127            /**
128             * Sets the user name of this email address.
129             *
130             * @param userName the user name of this email address
131             */
132            public void setUserName(String userName);
133    
134            /**
135             * Returns the create date of this email address.
136             *
137             * @return the create date of this email address
138             */
139            public Date getCreateDate();
140    
141            /**
142             * Sets the create date of this email address.
143             *
144             * @param createDate the create date of this email address
145             */
146            public void setCreateDate(Date createDate);
147    
148            /**
149             * Returns the modified date of this email address.
150             *
151             * @return the modified date of this email address
152             */
153            public Date getModifiedDate();
154    
155            /**
156             * Sets the modified date of this email address.
157             *
158             * @param modifiedDate the modified date of this email address
159             */
160            public void setModifiedDate(Date modifiedDate);
161    
162            /**
163             * Returns the fully qualified class name of this email address.
164             *
165             * @return the fully qualified class name of this email address
166             */
167            public String getClassName();
168    
169            /**
170             * Returns the class name ID of this email address.
171             *
172             * @return the class name ID of this email address
173             */
174            public long getClassNameId();
175    
176            /**
177             * Sets the class name ID of this email address.
178             *
179             * @param classNameId the class name ID of this email address
180             */
181            public void setClassNameId(long classNameId);
182    
183            /**
184             * Returns the class p k of this email address.
185             *
186             * @return the class p k of this email address
187             */
188            public long getClassPK();
189    
190            /**
191             * Sets the class p k of this email address.
192             *
193             * @param classPK the class p k of this email address
194             */
195            public void setClassPK(long classPK);
196    
197            /**
198             * Returns the address of this email address.
199             *
200             * @return the address of this email address
201             */
202            @AutoEscape
203            public String getAddress();
204    
205            /**
206             * Sets the address of this email address.
207             *
208             * @param address the address of this email address
209             */
210            public void setAddress(String address);
211    
212            /**
213             * Returns the type ID of this email address.
214             *
215             * @return the type ID of this email address
216             */
217            public int getTypeId();
218    
219            /**
220             * Sets the type ID of this email address.
221             *
222             * @param typeId the type ID of this email address
223             */
224            public void setTypeId(int typeId);
225    
226            /**
227             * Returns the primary of this email address.
228             *
229             * @return the primary of this email address
230             */
231            public boolean getPrimary();
232    
233            /**
234             * Returns <code>true</code> if this email address is primary.
235             *
236             * @return <code>true</code> if this email address is primary; <code>false</code> otherwise
237             */
238            public boolean isPrimary();
239    
240            /**
241             * Sets whether this email address is primary.
242             *
243             * @param primary the primary of this email address
244             */
245            public void setPrimary(boolean primary);
246    
247            public boolean isNew();
248    
249            public void setNew(boolean n);
250    
251            public boolean isCachedModel();
252    
253            public void setCachedModel(boolean cachedModel);
254    
255            public boolean isEscapedModel();
256    
257            public Serializable getPrimaryKeyObj();
258    
259            public void setPrimaryKeyObj(Serializable primaryKeyObj);
260    
261            public ExpandoBridge getExpandoBridge();
262    
263            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
264    
265            public Object clone();
266    
267            public int compareTo(EmailAddress emailAddress);
268    
269            public int hashCode();
270    
271            public CacheModel<EmailAddress> toCacheModel();
272    
273            public EmailAddress toEscapedModel();
274    
275            public String toString();
276    
277            public String toXmlString();
278    }