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