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.portlet.messageboards.model; 016 017 import com.liferay.portal.kernel.bean.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.model.BaseModel; 020 import com.liferay.portal.model.CacheModel; 021 import com.liferay.portal.model.StagedGroupedModel; 022 import com.liferay.portal.service.ServiceContext; 023 024 import com.liferay.portlet.expando.model.ExpandoBridge; 025 026 import java.io.Serializable; 027 028 import java.util.Date; 029 030 /** 031 * The base model interface for the MBMailingList service. Represents a row in the "MBMailingList" database table, with each column mapped to a property of this class. 032 * 033 * <p> 034 * This interface and its corresponding implementation {@link com.liferay.portlet.messageboards.model.impl.MBMailingListModelImpl} 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.portlet.messageboards.model.impl.MBMailingListImpl}. 035 * </p> 036 * 037 * @author Brian Wing Shun Chan 038 * @see MBMailingList 039 * @see com.liferay.portlet.messageboards.model.impl.MBMailingListImpl 040 * @see com.liferay.portlet.messageboards.model.impl.MBMailingListModelImpl 041 * @generated 042 */ 043 public interface MBMailingListModel extends BaseModel<MBMailingList>, 044 StagedGroupedModel { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. All methods that expect a message boards mailing list model instance should use the {@link MBMailingList} interface instead. 049 */ 050 051 /** 052 * Returns the primary key of this message boards mailing list. 053 * 054 * @return the primary key of this message boards mailing list 055 */ 056 public long getPrimaryKey(); 057 058 /** 059 * Sets the primary key of this message boards mailing list. 060 * 061 * @param primaryKey the primary key of this message boards mailing list 062 */ 063 public void setPrimaryKey(long primaryKey); 064 065 /** 066 * Returns the uuid of this message boards mailing list. 067 * 068 * @return the uuid of this message boards mailing list 069 */ 070 @AutoEscape 071 @Override 072 public String getUuid(); 073 074 /** 075 * Sets the uuid of this message boards mailing list. 076 * 077 * @param uuid the uuid of this message boards mailing list 078 */ 079 @Override 080 public void setUuid(String uuid); 081 082 /** 083 * Returns the mailing list ID of this message boards mailing list. 084 * 085 * @return the mailing list ID of this message boards mailing list 086 */ 087 public long getMailingListId(); 088 089 /** 090 * Sets the mailing list ID of this message boards mailing list. 091 * 092 * @param mailingListId the mailing list ID of this message boards mailing list 093 */ 094 public void setMailingListId(long mailingListId); 095 096 /** 097 * Returns the group ID of this message boards mailing list. 098 * 099 * @return the group ID of this message boards mailing list 100 */ 101 @Override 102 public long getGroupId(); 103 104 /** 105 * Sets the group ID of this message boards mailing list. 106 * 107 * @param groupId the group ID of this message boards mailing list 108 */ 109 @Override 110 public void setGroupId(long groupId); 111 112 /** 113 * Returns the company ID of this message boards mailing list. 114 * 115 * @return the company ID of this message boards mailing list 116 */ 117 @Override 118 public long getCompanyId(); 119 120 /** 121 * Sets the company ID of this message boards mailing list. 122 * 123 * @param companyId the company ID of this message boards mailing list 124 */ 125 @Override 126 public void setCompanyId(long companyId); 127 128 /** 129 * Returns the user ID of this message boards mailing list. 130 * 131 * @return the user ID of this message boards mailing list 132 */ 133 @Override 134 public long getUserId(); 135 136 /** 137 * Sets the user ID of this message boards mailing list. 138 * 139 * @param userId the user ID of this message boards mailing list 140 */ 141 @Override 142 public void setUserId(long userId); 143 144 /** 145 * Returns the user uuid of this message boards mailing list. 146 * 147 * @return the user uuid of this message boards mailing list 148 * @throws SystemException if a system exception occurred 149 */ 150 @Override 151 public String getUserUuid() throws SystemException; 152 153 /** 154 * Sets the user uuid of this message boards mailing list. 155 * 156 * @param userUuid the user uuid of this message boards mailing list 157 */ 158 @Override 159 public void setUserUuid(String userUuid); 160 161 /** 162 * Returns the user name of this message boards mailing list. 163 * 164 * @return the user name of this message boards mailing list 165 */ 166 @AutoEscape 167 @Override 168 public String getUserName(); 169 170 /** 171 * Sets the user name of this message boards mailing list. 172 * 173 * @param userName the user name of this message boards mailing list 174 */ 175 @Override 176 public void setUserName(String userName); 177 178 /** 179 * Returns the create date of this message boards mailing list. 180 * 181 * @return the create date of this message boards mailing list 182 */ 183 @Override 184 public Date getCreateDate(); 185 186 /** 187 * Sets the create date of this message boards mailing list. 188 * 189 * @param createDate the create date of this message boards mailing list 190 */ 191 @Override 192 public void setCreateDate(Date createDate); 193 194 /** 195 * Returns the modified date of this message boards mailing list. 196 * 197 * @return the modified date of this message boards mailing list 198 */ 199 @Override 200 public Date getModifiedDate(); 201 202 /** 203 * Sets the modified date of this message boards mailing list. 204 * 205 * @param modifiedDate the modified date of this message boards mailing list 206 */ 207 @Override 208 public void setModifiedDate(Date modifiedDate); 209 210 /** 211 * Returns the category ID of this message boards mailing list. 212 * 213 * @return the category ID of this message boards mailing list 214 */ 215 public long getCategoryId(); 216 217 /** 218 * Sets the category ID of this message boards mailing list. 219 * 220 * @param categoryId the category ID of this message boards mailing list 221 */ 222 public void setCategoryId(long categoryId); 223 224 /** 225 * Returns the email address of this message boards mailing list. 226 * 227 * @return the email address of this message boards mailing list 228 */ 229 @AutoEscape 230 public String getEmailAddress(); 231 232 /** 233 * Sets the email address of this message boards mailing list. 234 * 235 * @param emailAddress the email address of this message boards mailing list 236 */ 237 public void setEmailAddress(String emailAddress); 238 239 /** 240 * Returns the in protocol of this message boards mailing list. 241 * 242 * @return the in protocol of this message boards mailing list 243 */ 244 @AutoEscape 245 public String getInProtocol(); 246 247 /** 248 * Sets the in protocol of this message boards mailing list. 249 * 250 * @param inProtocol the in protocol of this message boards mailing list 251 */ 252 public void setInProtocol(String inProtocol); 253 254 /** 255 * Returns the in server name of this message boards mailing list. 256 * 257 * @return the in server name of this message boards mailing list 258 */ 259 @AutoEscape 260 public String getInServerName(); 261 262 /** 263 * Sets the in server name of this message boards mailing list. 264 * 265 * @param inServerName the in server name of this message boards mailing list 266 */ 267 public void setInServerName(String inServerName); 268 269 /** 270 * Returns the in server port of this message boards mailing list. 271 * 272 * @return the in server port of this message boards mailing list 273 */ 274 public int getInServerPort(); 275 276 /** 277 * Sets the in server port of this message boards mailing list. 278 * 279 * @param inServerPort the in server port of this message boards mailing list 280 */ 281 public void setInServerPort(int inServerPort); 282 283 /** 284 * Returns the in use s s l of this message boards mailing list. 285 * 286 * @return the in use s s l of this message boards mailing list 287 */ 288 public boolean getInUseSSL(); 289 290 /** 291 * Returns <code>true</code> if this message boards mailing list is in use s s l. 292 * 293 * @return <code>true</code> if this message boards mailing list is in use s s l; <code>false</code> otherwise 294 */ 295 public boolean isInUseSSL(); 296 297 /** 298 * Sets whether this message boards mailing list is in use s s l. 299 * 300 * @param inUseSSL the in use s s l of this message boards mailing list 301 */ 302 public void setInUseSSL(boolean inUseSSL); 303 304 /** 305 * Returns the in user name of this message boards mailing list. 306 * 307 * @return the in user name of this message boards mailing list 308 */ 309 @AutoEscape 310 public String getInUserName(); 311 312 /** 313 * Sets the in user name of this message boards mailing list. 314 * 315 * @param inUserName the in user name of this message boards mailing list 316 */ 317 public void setInUserName(String inUserName); 318 319 /** 320 * Returns the in password of this message boards mailing list. 321 * 322 * @return the in password of this message boards mailing list 323 */ 324 @AutoEscape 325 public String getInPassword(); 326 327 /** 328 * Sets the in password of this message boards mailing list. 329 * 330 * @param inPassword the in password of this message boards mailing list 331 */ 332 public void setInPassword(String inPassword); 333 334 /** 335 * Returns the in read interval of this message boards mailing list. 336 * 337 * @return the in read interval of this message boards mailing list 338 */ 339 public int getInReadInterval(); 340 341 /** 342 * Sets the in read interval of this message boards mailing list. 343 * 344 * @param inReadInterval the in read interval of this message boards mailing list 345 */ 346 public void setInReadInterval(int inReadInterval); 347 348 /** 349 * Returns the out email address of this message boards mailing list. 350 * 351 * @return the out email address of this message boards mailing list 352 */ 353 @AutoEscape 354 public String getOutEmailAddress(); 355 356 /** 357 * Sets the out email address of this message boards mailing list. 358 * 359 * @param outEmailAddress the out email address of this message boards mailing list 360 */ 361 public void setOutEmailAddress(String outEmailAddress); 362 363 /** 364 * Returns the out custom of this message boards mailing list. 365 * 366 * @return the out custom of this message boards mailing list 367 */ 368 public boolean getOutCustom(); 369 370 /** 371 * Returns <code>true</code> if this message boards mailing list is out custom. 372 * 373 * @return <code>true</code> if this message boards mailing list is out custom; <code>false</code> otherwise 374 */ 375 public boolean isOutCustom(); 376 377 /** 378 * Sets whether this message boards mailing list is out custom. 379 * 380 * @param outCustom the out custom of this message boards mailing list 381 */ 382 public void setOutCustom(boolean outCustom); 383 384 /** 385 * Returns the out server name of this message boards mailing list. 386 * 387 * @return the out server name of this message boards mailing list 388 */ 389 @AutoEscape 390 public String getOutServerName(); 391 392 /** 393 * Sets the out server name of this message boards mailing list. 394 * 395 * @param outServerName the out server name of this message boards mailing list 396 */ 397 public void setOutServerName(String outServerName); 398 399 /** 400 * Returns the out server port of this message boards mailing list. 401 * 402 * @return the out server port of this message boards mailing list 403 */ 404 public int getOutServerPort(); 405 406 /** 407 * Sets the out server port of this message boards mailing list. 408 * 409 * @param outServerPort the out server port of this message boards mailing list 410 */ 411 public void setOutServerPort(int outServerPort); 412 413 /** 414 * Returns the out use s s l of this message boards mailing list. 415 * 416 * @return the out use s s l of this message boards mailing list 417 */ 418 public boolean getOutUseSSL(); 419 420 /** 421 * Returns <code>true</code> if this message boards mailing list is out use s s l. 422 * 423 * @return <code>true</code> if this message boards mailing list is out use s s l; <code>false</code> otherwise 424 */ 425 public boolean isOutUseSSL(); 426 427 /** 428 * Sets whether this message boards mailing list is out use s s l. 429 * 430 * @param outUseSSL the out use s s l of this message boards mailing list 431 */ 432 public void setOutUseSSL(boolean outUseSSL); 433 434 /** 435 * Returns the out user name of this message boards mailing list. 436 * 437 * @return the out user name of this message boards mailing list 438 */ 439 @AutoEscape 440 public String getOutUserName(); 441 442 /** 443 * Sets the out user name of this message boards mailing list. 444 * 445 * @param outUserName the out user name of this message boards mailing list 446 */ 447 public void setOutUserName(String outUserName); 448 449 /** 450 * Returns the out password of this message boards mailing list. 451 * 452 * @return the out password of this message boards mailing list 453 */ 454 @AutoEscape 455 public String getOutPassword(); 456 457 /** 458 * Sets the out password of this message boards mailing list. 459 * 460 * @param outPassword the out password of this message boards mailing list 461 */ 462 public void setOutPassword(String outPassword); 463 464 /** 465 * Returns the allow anonymous of this message boards mailing list. 466 * 467 * @return the allow anonymous of this message boards mailing list 468 */ 469 public boolean getAllowAnonymous(); 470 471 /** 472 * Returns <code>true</code> if this message boards mailing list is allow anonymous. 473 * 474 * @return <code>true</code> if this message boards mailing list is allow anonymous; <code>false</code> otherwise 475 */ 476 public boolean isAllowAnonymous(); 477 478 /** 479 * Sets whether this message boards mailing list is allow anonymous. 480 * 481 * @param allowAnonymous the allow anonymous of this message boards mailing list 482 */ 483 public void setAllowAnonymous(boolean allowAnonymous); 484 485 /** 486 * Returns the active of this message boards mailing list. 487 * 488 * @return the active of this message boards mailing list 489 */ 490 public boolean getActive(); 491 492 /** 493 * Returns <code>true</code> if this message boards mailing list is active. 494 * 495 * @return <code>true</code> if this message boards mailing list is active; <code>false</code> otherwise 496 */ 497 public boolean isActive(); 498 499 /** 500 * Sets whether this message boards mailing list is active. 501 * 502 * @param active the active of this message boards mailing list 503 */ 504 public void setActive(boolean active); 505 506 @Override 507 public boolean isNew(); 508 509 @Override 510 public void setNew(boolean n); 511 512 @Override 513 public boolean isCachedModel(); 514 515 @Override 516 public void setCachedModel(boolean cachedModel); 517 518 @Override 519 public boolean isEscapedModel(); 520 521 @Override 522 public Serializable getPrimaryKeyObj(); 523 524 @Override 525 public void setPrimaryKeyObj(Serializable primaryKeyObj); 526 527 @Override 528 public ExpandoBridge getExpandoBridge(); 529 530 @Override 531 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 532 533 @Override 534 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 535 536 @Override 537 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 538 539 @Override 540 public Object clone(); 541 542 @Override 543 public int compareTo(MBMailingList mbMailingList); 544 545 @Override 546 public int hashCode(); 547 548 @Override 549 public CacheModel<MBMailingList> toCacheModel(); 550 551 @Override 552 public MBMailingList toEscapedModel(); 553 554 @Override 555 public MBMailingList toUnescapedModel(); 556 557 @Override 558 public String toString(); 559 560 @Override 561 public String toXmlString(); 562 }