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