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