001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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 Contact service. Represents a row in the "Contact_" 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.ContactModelImpl} 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.ContactImpl}.
032     * </p>
033     *
034     * <p>
035     * Never modify or reference this interface directly. All methods that expect a contact model instance should use the {@link Contact} interface instead.
036     * </p>
037     *
038     * @author Brian Wing Shun Chan
039     * @see Contact
040     * @see com.liferay.portal.model.impl.ContactImpl
041     * @see com.liferay.portal.model.impl.ContactModelImpl
042     * @generated
043     */
044    public interface ContactModel extends BaseModel<Contact> {
045            /**
046             * Gets the primary key of this contact.
047             *
048             * @return the primary key of this contact
049             */
050            public long getPrimaryKey();
051    
052            /**
053             * Sets the primary key of this contact
054             *
055             * @param pk the primary key of this contact
056             */
057            public void setPrimaryKey(long pk);
058    
059            /**
060             * Gets the contact id of this contact.
061             *
062             * @return the contact id of this contact
063             */
064            public long getContactId();
065    
066            /**
067             * Sets the contact id of this contact.
068             *
069             * @param contactId the contact id of this contact
070             */
071            public void setContactId(long contactId);
072    
073            /**
074             * Gets the company id of this contact.
075             *
076             * @return the company id of this contact
077             */
078            public long getCompanyId();
079    
080            /**
081             * Sets the company id of this contact.
082             *
083             * @param companyId the company id of this contact
084             */
085            public void setCompanyId(long companyId);
086    
087            /**
088             * Gets the user id of this contact.
089             *
090             * @return the user id of this contact
091             */
092            public long getUserId();
093    
094            /**
095             * Sets the user id of this contact.
096             *
097             * @param userId the user id of this contact
098             */
099            public void setUserId(long userId);
100    
101            /**
102             * Gets the user uuid of this contact.
103             *
104             * @return the user uuid of this contact
105             * @throws SystemException if a system exception occurred
106             */
107            public String getUserUuid() throws SystemException;
108    
109            /**
110             * Sets the user uuid of this contact.
111             *
112             * @param userUuid the user uuid of this contact
113             */
114            public void setUserUuid(String userUuid);
115    
116            /**
117             * Gets the user name of this contact.
118             *
119             * @return the user name of this contact
120             */
121            @AutoEscape
122            public String getUserName();
123    
124            /**
125             * Sets the user name of this contact.
126             *
127             * @param userName the user name of this contact
128             */
129            public void setUserName(String userName);
130    
131            /**
132             * Gets the create date of this contact.
133             *
134             * @return the create date of this contact
135             */
136            public Date getCreateDate();
137    
138            /**
139             * Sets the create date of this contact.
140             *
141             * @param createDate the create date of this contact
142             */
143            public void setCreateDate(Date createDate);
144    
145            /**
146             * Gets the modified date of this contact.
147             *
148             * @return the modified date of this contact
149             */
150            public Date getModifiedDate();
151    
152            /**
153             * Sets the modified date of this contact.
154             *
155             * @param modifiedDate the modified date of this contact
156             */
157            public void setModifiedDate(Date modifiedDate);
158    
159            /**
160             * Gets the account id of this contact.
161             *
162             * @return the account id of this contact
163             */
164            public long getAccountId();
165    
166            /**
167             * Sets the account id of this contact.
168             *
169             * @param accountId the account id of this contact
170             */
171            public void setAccountId(long accountId);
172    
173            /**
174             * Gets the parent contact id of this contact.
175             *
176             * @return the parent contact id of this contact
177             */
178            public long getParentContactId();
179    
180            /**
181             * Sets the parent contact id of this contact.
182             *
183             * @param parentContactId the parent contact id of this contact
184             */
185            public void setParentContactId(long parentContactId);
186    
187            /**
188             * Gets the first name of this contact.
189             *
190             * @return the first name of this contact
191             */
192            @AutoEscape
193            public String getFirstName();
194    
195            /**
196             * Sets the first name of this contact.
197             *
198             * @param firstName the first name of this contact
199             */
200            public void setFirstName(String firstName);
201    
202            /**
203             * Gets the middle name of this contact.
204             *
205             * @return the middle name of this contact
206             */
207            @AutoEscape
208            public String getMiddleName();
209    
210            /**
211             * Sets the middle name of this contact.
212             *
213             * @param middleName the middle name of this contact
214             */
215            public void setMiddleName(String middleName);
216    
217            /**
218             * Gets the last name of this contact.
219             *
220             * @return the last name of this contact
221             */
222            @AutoEscape
223            public String getLastName();
224    
225            /**
226             * Sets the last name of this contact.
227             *
228             * @param lastName the last name of this contact
229             */
230            public void setLastName(String lastName);
231    
232            /**
233             * Gets the prefix id of this contact.
234             *
235             * @return the prefix id of this contact
236             */
237            public int getPrefixId();
238    
239            /**
240             * Sets the prefix id of this contact.
241             *
242             * @param prefixId the prefix id of this contact
243             */
244            public void setPrefixId(int prefixId);
245    
246            /**
247             * Gets the suffix id of this contact.
248             *
249             * @return the suffix id of this contact
250             */
251            public int getSuffixId();
252    
253            /**
254             * Sets the suffix id of this contact.
255             *
256             * @param suffixId the suffix id of this contact
257             */
258            public void setSuffixId(int suffixId);
259    
260            /**
261             * Gets the male of this contact.
262             *
263             * @return the male of this contact
264             */
265            public boolean getMale();
266    
267            /**
268             * Determines whether this contact is male.
269             *
270             * @return whether this contact is male
271             */
272            public boolean isMale();
273    
274            /**
275             * Sets whether this {$entity.humanName} is male.
276             *
277             * @param male the male of this contact
278             */
279            public void setMale(boolean male);
280    
281            /**
282             * Gets the birthday of this contact.
283             *
284             * @return the birthday of this contact
285             */
286            public Date getBirthday();
287    
288            /**
289             * Sets the birthday of this contact.
290             *
291             * @param birthday the birthday of this contact
292             */
293            public void setBirthday(Date birthday);
294    
295            /**
296             * Gets the sms sn of this contact.
297             *
298             * @return the sms sn of this contact
299             */
300            @AutoEscape
301            public String getSmsSn();
302    
303            /**
304             * Sets the sms sn of this contact.
305             *
306             * @param smsSn the sms sn of this contact
307             */
308            public void setSmsSn(String smsSn);
309    
310            /**
311             * Gets the aim sn of this contact.
312             *
313             * @return the aim sn of this contact
314             */
315            @AutoEscape
316            public String getAimSn();
317    
318            /**
319             * Sets the aim sn of this contact.
320             *
321             * @param aimSn the aim sn of this contact
322             */
323            public void setAimSn(String aimSn);
324    
325            /**
326             * Gets the facebook sn of this contact.
327             *
328             * @return the facebook sn of this contact
329             */
330            @AutoEscape
331            public String getFacebookSn();
332    
333            /**
334             * Sets the facebook sn of this contact.
335             *
336             * @param facebookSn the facebook sn of this contact
337             */
338            public void setFacebookSn(String facebookSn);
339    
340            /**
341             * Gets the icq sn of this contact.
342             *
343             * @return the icq sn of this contact
344             */
345            @AutoEscape
346            public String getIcqSn();
347    
348            /**
349             * Sets the icq sn of this contact.
350             *
351             * @param icqSn the icq sn of this contact
352             */
353            public void setIcqSn(String icqSn);
354    
355            /**
356             * Gets the jabber sn of this contact.
357             *
358             * @return the jabber sn of this contact
359             */
360            @AutoEscape
361            public String getJabberSn();
362    
363            /**
364             * Sets the jabber sn of this contact.
365             *
366             * @param jabberSn the jabber sn of this contact
367             */
368            public void setJabberSn(String jabberSn);
369    
370            /**
371             * Gets the msn sn of this contact.
372             *
373             * @return the msn sn of this contact
374             */
375            @AutoEscape
376            public String getMsnSn();
377    
378            /**
379             * Sets the msn sn of this contact.
380             *
381             * @param msnSn the msn sn of this contact
382             */
383            public void setMsnSn(String msnSn);
384    
385            /**
386             * Gets the my space sn of this contact.
387             *
388             * @return the my space sn of this contact
389             */
390            @AutoEscape
391            public String getMySpaceSn();
392    
393            /**
394             * Sets the my space sn of this contact.
395             *
396             * @param mySpaceSn the my space sn of this contact
397             */
398            public void setMySpaceSn(String mySpaceSn);
399    
400            /**
401             * Gets the skype sn of this contact.
402             *
403             * @return the skype sn of this contact
404             */
405            @AutoEscape
406            public String getSkypeSn();
407    
408            /**
409             * Sets the skype sn of this contact.
410             *
411             * @param skypeSn the skype sn of this contact
412             */
413            public void setSkypeSn(String skypeSn);
414    
415            /**
416             * Gets the twitter sn of this contact.
417             *
418             * @return the twitter sn of this contact
419             */
420            @AutoEscape
421            public String getTwitterSn();
422    
423            /**
424             * Sets the twitter sn of this contact.
425             *
426             * @param twitterSn the twitter sn of this contact
427             */
428            public void setTwitterSn(String twitterSn);
429    
430            /**
431             * Gets the ym sn of this contact.
432             *
433             * @return the ym sn of this contact
434             */
435            @AutoEscape
436            public String getYmSn();
437    
438            /**
439             * Sets the ym sn of this contact.
440             *
441             * @param ymSn the ym sn of this contact
442             */
443            public void setYmSn(String ymSn);
444    
445            /**
446             * Gets the employee status id of this contact.
447             *
448             * @return the employee status id of this contact
449             */
450            @AutoEscape
451            public String getEmployeeStatusId();
452    
453            /**
454             * Sets the employee status id of this contact.
455             *
456             * @param employeeStatusId the employee status id of this contact
457             */
458            public void setEmployeeStatusId(String employeeStatusId);
459    
460            /**
461             * Gets the employee number of this contact.
462             *
463             * @return the employee number of this contact
464             */
465            @AutoEscape
466            public String getEmployeeNumber();
467    
468            /**
469             * Sets the employee number of this contact.
470             *
471             * @param employeeNumber the employee number of this contact
472             */
473            public void setEmployeeNumber(String employeeNumber);
474    
475            /**
476             * Gets the job title of this contact.
477             *
478             * @return the job title of this contact
479             */
480            @AutoEscape
481            public String getJobTitle();
482    
483            /**
484             * Sets the job title of this contact.
485             *
486             * @param jobTitle the job title of this contact
487             */
488            public void setJobTitle(String jobTitle);
489    
490            /**
491             * Gets the job class of this contact.
492             *
493             * @return the job class of this contact
494             */
495            @AutoEscape
496            public String getJobClass();
497    
498            /**
499             * Sets the job class of this contact.
500             *
501             * @param jobClass the job class of this contact
502             */
503            public void setJobClass(String jobClass);
504    
505            /**
506             * Gets the hours of operation of this contact.
507             *
508             * @return the hours of operation of this contact
509             */
510            @AutoEscape
511            public String getHoursOfOperation();
512    
513            /**
514             * Sets the hours of operation of this contact.
515             *
516             * @param hoursOfOperation the hours of operation of this contact
517             */
518            public void setHoursOfOperation(String hoursOfOperation);
519    
520            public boolean isNew();
521    
522            public void setNew(boolean n);
523    
524            public boolean isCachedModel();
525    
526            public void setCachedModel(boolean cachedModel);
527    
528            public boolean isEscapedModel();
529    
530            public void setEscapedModel(boolean escapedModel);
531    
532            public Serializable getPrimaryKeyObj();
533    
534            public ExpandoBridge getExpandoBridge();
535    
536            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
537    
538            public Object clone();
539    
540            public int compareTo(Contact contact);
541    
542            public int hashCode();
543    
544            public Contact toEscapedModel();
545    
546            public String toString();
547    
548            public String toXmlString();
549    }