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