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