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