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 Address service. Represents a row in the "Address" 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.AddressModelImpl} 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.AddressImpl}.
033     * </p>
034     *
035     * @author Brian Wing Shun Chan
036     * @see Address
037     * @see com.liferay.portal.model.impl.AddressImpl
038     * @see com.liferay.portal.model.impl.AddressModelImpl
039     * @generated
040     */
041    @ProviderType
042    public interface AddressModel extends AttachedModel, BaseModel<Address>,
043            MVCCModel, ShardedModel, StagedAuditedModel {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * Never modify or reference this interface directly. All methods that expect a address model instance should use the {@link Address} interface instead.
048             */
049    
050            /**
051             * Returns the primary key of this address.
052             *
053             * @return the primary key of this address
054             */
055            public long getPrimaryKey();
056    
057            /**
058             * Sets the primary key of this address.
059             *
060             * @param primaryKey the primary key of this address
061             */
062            public void setPrimaryKey(long primaryKey);
063    
064            /**
065             * Returns the mvcc version of this address.
066             *
067             * @return the mvcc version of this address
068             */
069            @Override
070            public long getMvccVersion();
071    
072            /**
073             * Sets the mvcc version of this address.
074             *
075             * @param mvccVersion the mvcc version of this address
076             */
077            @Override
078            public void setMvccVersion(long mvccVersion);
079    
080            /**
081             * Returns the uuid of this address.
082             *
083             * @return the uuid of this address
084             */
085            @AutoEscape
086            @Override
087            public String getUuid();
088    
089            /**
090             * Sets the uuid of this address.
091             *
092             * @param uuid the uuid of this address
093             */
094            @Override
095            public void setUuid(String uuid);
096    
097            /**
098             * Returns the address ID of this address.
099             *
100             * @return the address ID of this address
101             */
102            public long getAddressId();
103    
104            /**
105             * Sets the address ID of this address.
106             *
107             * @param addressId the address ID of this address
108             */
109            public void setAddressId(long addressId);
110    
111            /**
112             * Returns the company ID of this address.
113             *
114             * @return the company ID of this address
115             */
116            @Override
117            public long getCompanyId();
118    
119            /**
120             * Sets the company ID of this address.
121             *
122             * @param companyId the company ID of this address
123             */
124            @Override
125            public void setCompanyId(long companyId);
126    
127            /**
128             * Returns the user ID of this address.
129             *
130             * @return the user ID of this address
131             */
132            @Override
133            public long getUserId();
134    
135            /**
136             * Sets the user ID of this address.
137             *
138             * @param userId the user ID of this address
139             */
140            @Override
141            public void setUserId(long userId);
142    
143            /**
144             * Returns the user uuid of this address.
145             *
146             * @return the user uuid of this address
147             */
148            @Override
149            public String getUserUuid();
150    
151            /**
152             * Sets the user uuid of this address.
153             *
154             * @param userUuid the user uuid of this address
155             */
156            @Override
157            public void setUserUuid(String userUuid);
158    
159            /**
160             * Returns the user name of this address.
161             *
162             * @return the user name of this address
163             */
164            @AutoEscape
165            @Override
166            public String getUserName();
167    
168            /**
169             * Sets the user name of this address.
170             *
171             * @param userName the user name of this address
172             */
173            @Override
174            public void setUserName(String userName);
175    
176            /**
177             * Returns the create date of this address.
178             *
179             * @return the create date of this address
180             */
181            @Override
182            public Date getCreateDate();
183    
184            /**
185             * Sets the create date of this address.
186             *
187             * @param createDate the create date of this address
188             */
189            @Override
190            public void setCreateDate(Date createDate);
191    
192            /**
193             * Returns the modified date of this address.
194             *
195             * @return the modified date of this address
196             */
197            @Override
198            public Date getModifiedDate();
199    
200            /**
201             * Sets the modified date of this address.
202             *
203             * @param modifiedDate the modified date of this address
204             */
205            @Override
206            public void setModifiedDate(Date modifiedDate);
207    
208            /**
209             * Returns the fully qualified class name of this address.
210             *
211             * @return the fully qualified class name of this 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 address.
220             *
221             * @return the class name ID of this address
222             */
223            @Override
224            public long getClassNameId();
225    
226            /**
227             * Sets the class name ID of this address.
228             *
229             * @param classNameId the class name ID of this address
230             */
231            @Override
232            public void setClassNameId(long classNameId);
233    
234            /**
235             * Returns the class p k of this address.
236             *
237             * @return the class p k of this address
238             */
239            @Override
240            public long getClassPK();
241    
242            /**
243             * Sets the class p k of this address.
244             *
245             * @param classPK the class p k of this address
246             */
247            @Override
248            public void setClassPK(long classPK);
249    
250            /**
251             * Returns the street1 of this address.
252             *
253             * @return the street1 of this address
254             */
255            @AutoEscape
256            public String getStreet1();
257    
258            /**
259             * Sets the street1 of this address.
260             *
261             * @param street1 the street1 of this address
262             */
263            public void setStreet1(String street1);
264    
265            /**
266             * Returns the street2 of this address.
267             *
268             * @return the street2 of this address
269             */
270            @AutoEscape
271            public String getStreet2();
272    
273            /**
274             * Sets the street2 of this address.
275             *
276             * @param street2 the street2 of this address
277             */
278            public void setStreet2(String street2);
279    
280            /**
281             * Returns the street3 of this address.
282             *
283             * @return the street3 of this address
284             */
285            @AutoEscape
286            public String getStreet3();
287    
288            /**
289             * Sets the street3 of this address.
290             *
291             * @param street3 the street3 of this address
292             */
293            public void setStreet3(String street3);
294    
295            /**
296             * Returns the city of this address.
297             *
298             * @return the city of this address
299             */
300            @AutoEscape
301            public String getCity();
302    
303            /**
304             * Sets the city of this address.
305             *
306             * @param city the city of this address
307             */
308            public void setCity(String city);
309    
310            /**
311             * Returns the zip of this address.
312             *
313             * @return the zip of this address
314             */
315            @AutoEscape
316            public String getZip();
317    
318            /**
319             * Sets the zip of this address.
320             *
321             * @param zip the zip of this address
322             */
323            public void setZip(String zip);
324    
325            /**
326             * Returns the region ID of this address.
327             *
328             * @return the region ID of this address
329             */
330            public long getRegionId();
331    
332            /**
333             * Sets the region ID of this address.
334             *
335             * @param regionId the region ID of this address
336             */
337            public void setRegionId(long regionId);
338    
339            /**
340             * Returns the country ID of this address.
341             *
342             * @return the country ID of this address
343             */
344            public long getCountryId();
345    
346            /**
347             * Sets the country ID of this address.
348             *
349             * @param countryId the country ID of this address
350             */
351            public void setCountryId(long countryId);
352    
353            /**
354             * Returns the type ID of this address.
355             *
356             * @return the type ID of this address
357             */
358            public long getTypeId();
359    
360            /**
361             * Sets the type ID of this address.
362             *
363             * @param typeId the type ID of this address
364             */
365            public void setTypeId(long typeId);
366    
367            /**
368             * Returns the mailing of this address.
369             *
370             * @return the mailing of this address
371             */
372            public boolean getMailing();
373    
374            /**
375             * Returns <code>true</code> if this address is mailing.
376             *
377             * @return <code>true</code> if this address is mailing; <code>false</code> otherwise
378             */
379            public boolean isMailing();
380    
381            /**
382             * Sets whether this address is mailing.
383             *
384             * @param mailing the mailing of this address
385             */
386            public void setMailing(boolean mailing);
387    
388            /**
389             * Returns the primary of this address.
390             *
391             * @return the primary of this address
392             */
393            public boolean getPrimary();
394    
395            /**
396             * Returns <code>true</code> if this address is primary.
397             *
398             * @return <code>true</code> if this address is primary; <code>false</code> otherwise
399             */
400            public boolean isPrimary();
401    
402            /**
403             * Sets whether this address is primary.
404             *
405             * @param primary the primary of this address
406             */
407            public void setPrimary(boolean primary);
408    
409            @Override
410            public boolean isNew();
411    
412            @Override
413            public void setNew(boolean n);
414    
415            @Override
416            public boolean isCachedModel();
417    
418            @Override
419            public void setCachedModel(boolean cachedModel);
420    
421            @Override
422            public boolean isEscapedModel();
423    
424            @Override
425            public Serializable getPrimaryKeyObj();
426    
427            @Override
428            public void setPrimaryKeyObj(Serializable primaryKeyObj);
429    
430            @Override
431            public ExpandoBridge getExpandoBridge();
432    
433            @Override
434            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
435    
436            @Override
437            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
438    
439            @Override
440            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
441    
442            @Override
443            public Object clone();
444    
445            @Override
446            public int compareTo(com.liferay.portal.model.Address address);
447    
448            @Override
449            public int hashCode();
450    
451            @Override
452            public CacheModel<com.liferay.portal.model.Address> toCacheModel();
453    
454            @Override
455            public com.liferay.portal.model.Address toEscapedModel();
456    
457            @Override
458            public com.liferay.portal.model.Address toUnescapedModel();
459    
460            @Override
461            public String toString();
462    
463            @Override
464            public String toXmlString();
465    }