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