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