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