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 aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.bean.AutoEscape; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.model.BaseModel; 022 import com.liferay.portal.model.CacheModel; 023 import com.liferay.portal.model.StagedGroupedModel; 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 StagedGroupedModel { 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 * @throws SystemException if a system exception occurred 152 */ 153 @Override 154 public String getUserUuid() throws SystemException; 155 156 /** 157 * Sets the user uuid of this message boards mailing list. 158 * 159 * @param userUuid the user uuid of this message boards mailing list 160 */ 161 @Override 162 public void setUserUuid(String userUuid); 163 164 /** 165 * Returns the user name of this message boards mailing list. 166 * 167 * @return the user name of this message boards mailing list 168 */ 169 @AutoEscape 170 @Override 171 public String getUserName(); 172 173 /** 174 * Sets the user name of this message boards mailing list. 175 * 176 * @param userName the user name of this message boards mailing list 177 */ 178 @Override 179 public void setUserName(String userName); 180 181 /** 182 * Returns the create date of this message boards mailing list. 183 * 184 * @return the create date of this message boards mailing list 185 */ 186 @Override 187 public Date getCreateDate(); 188 189 /** 190 * Sets the create date of this message boards mailing list. 191 * 192 * @param createDate the create date of this message boards mailing list 193 */ 194 @Override 195 public void setCreateDate(Date createDate); 196 197 /** 198 * Returns the modified date of this message boards mailing list. 199 * 200 * @return the modified date of this message boards mailing list 201 */ 202 @Override 203 public Date getModifiedDate(); 204 205 /** 206 * Sets the modified date of this message boards mailing list. 207 * 208 * @param modifiedDate the modified date of this message boards mailing list 209 */ 210 @Override 211 public void setModifiedDate(Date modifiedDate); 212 213 /** 214 * Returns the category ID of this message boards mailing list. 215 * 216 * @return the category ID of this message boards mailing list 217 */ 218 public long getCategoryId(); 219 220 /** 221 * Sets the category ID of this message boards mailing list. 222 * 223 * @param categoryId the category ID of this message boards mailing list 224 */ 225 public void setCategoryId(long categoryId); 226 227 /** 228 * Returns the email address of this message boards mailing list. 229 * 230 * @return the email address of this message boards mailing list 231 */ 232 @AutoEscape 233 public String getEmailAddress(); 234 235 /** 236 * Sets the email address of this message boards mailing list. 237 * 238 * @param emailAddress the email address of this message boards mailing list 239 */ 240 public void setEmailAddress(String emailAddress); 241 242 /** 243 * Returns the in protocol of this message boards mailing list. 244 * 245 * @return the in protocol of this message boards mailing list 246 */ 247 @AutoEscape 248 public String getInProtocol(); 249 250 /** 251 * Sets the in protocol of this message boards mailing list. 252 * 253 * @param inProtocol the in protocol of this message boards mailing list 254 */ 255 public void setInProtocol(String inProtocol); 256 257 /** 258 * Returns the in server name of this message boards mailing list. 259 * 260 * @return the in server name of this message boards mailing list 261 */ 262 @AutoEscape 263 public String getInServerName(); 264 265 /** 266 * Sets the in server name of this message boards mailing list. 267 * 268 * @param inServerName the in server name of this message boards mailing list 269 */ 270 public void setInServerName(String inServerName); 271 272 /** 273 * Returns the in server port of this message boards mailing list. 274 * 275 * @return the in server port of this message boards mailing list 276 */ 277 public int getInServerPort(); 278 279 /** 280 * Sets the in server port of this message boards mailing list. 281 * 282 * @param inServerPort the in server port of this message boards mailing list 283 */ 284 public void setInServerPort(int inServerPort); 285 286 /** 287 * Returns the in use s s l of this message boards mailing list. 288 * 289 * @return the in use s s l of this message boards mailing list 290 */ 291 public boolean getInUseSSL(); 292 293 /** 294 * Returns <code>true</code> if this message boards mailing list is in use s s l. 295 * 296 * @return <code>true</code> if this message boards mailing list is in use s s l; <code>false</code> otherwise 297 */ 298 public boolean isInUseSSL(); 299 300 /** 301 * Sets whether this message boards mailing list is in use s s l. 302 * 303 * @param inUseSSL the in use s s l of this message boards mailing list 304 */ 305 public void setInUseSSL(boolean inUseSSL); 306 307 /** 308 * Returns the in user name of this message boards mailing list. 309 * 310 * @return the in user name of this message boards mailing list 311 */ 312 @AutoEscape 313 public String getInUserName(); 314 315 /** 316 * Sets the in user name of this message boards mailing list. 317 * 318 * @param inUserName the in user name of this message boards mailing list 319 */ 320 public void setInUserName(String inUserName); 321 322 /** 323 * Returns the in password of this message boards mailing list. 324 * 325 * @return the in password of this message boards mailing list 326 */ 327 @AutoEscape 328 public String getInPassword(); 329 330 /** 331 * Sets the in password of this message boards mailing list. 332 * 333 * @param inPassword the in password of this message boards mailing list 334 */ 335 public void setInPassword(String inPassword); 336 337 /** 338 * Returns the in read interval of this message boards mailing list. 339 * 340 * @return the in read interval of this message boards mailing list 341 */ 342 public int getInReadInterval(); 343 344 /** 345 * Sets the in read interval of this message boards mailing list. 346 * 347 * @param inReadInterval the in read interval of this message boards mailing list 348 */ 349 public void setInReadInterval(int inReadInterval); 350 351 /** 352 * Returns the out email address of this message boards mailing list. 353 * 354 * @return the out email address of this message boards mailing list 355 */ 356 @AutoEscape 357 public String getOutEmailAddress(); 358 359 /** 360 * Sets the out email address of this message boards mailing list. 361 * 362 * @param outEmailAddress the out email address of this message boards mailing list 363 */ 364 public void setOutEmailAddress(String outEmailAddress); 365 366 /** 367 * Returns the out custom of this message boards mailing list. 368 * 369 * @return the out custom of this message boards mailing list 370 */ 371 public boolean getOutCustom(); 372 373 /** 374 * Returns <code>true</code> if this message boards mailing list is out custom. 375 * 376 * @return <code>true</code> if this message boards mailing list is out custom; <code>false</code> otherwise 377 */ 378 public boolean isOutCustom(); 379 380 /** 381 * Sets whether this message boards mailing list is out custom. 382 * 383 * @param outCustom the out custom of this message boards mailing list 384 */ 385 public void setOutCustom(boolean outCustom); 386 387 /** 388 * Returns the out server name of this message boards mailing list. 389 * 390 * @return the out server name of this message boards mailing list 391 */ 392 @AutoEscape 393 public String getOutServerName(); 394 395 /** 396 * Sets the out server name of this message boards mailing list. 397 * 398 * @param outServerName the out server name of this message boards mailing list 399 */ 400 public void setOutServerName(String outServerName); 401 402 /** 403 * Returns the out server port of this message boards mailing list. 404 * 405 * @return the out server port of this message boards mailing list 406 */ 407 public int getOutServerPort(); 408 409 /** 410 * Sets the out server port of this message boards mailing list. 411 * 412 * @param outServerPort the out server port of this message boards mailing list 413 */ 414 public void setOutServerPort(int outServerPort); 415 416 /** 417 * Returns the out use s s l of this message boards mailing list. 418 * 419 * @return the out use s s l of this message boards mailing list 420 */ 421 public boolean getOutUseSSL(); 422 423 /** 424 * Returns <code>true</code> if this message boards mailing list is out use s s l. 425 * 426 * @return <code>true</code> if this message boards mailing list is out use s s l; <code>false</code> otherwise 427 */ 428 public boolean isOutUseSSL(); 429 430 /** 431 * Sets whether this message boards mailing list is out use s s l. 432 * 433 * @param outUseSSL the out use s s l of this message boards mailing list 434 */ 435 public void setOutUseSSL(boolean outUseSSL); 436 437 /** 438 * Returns the out user name of this message boards mailing list. 439 * 440 * @return the out user name of this message boards mailing list 441 */ 442 @AutoEscape 443 public String getOutUserName(); 444 445 /** 446 * Sets the out user name of this message boards mailing list. 447 * 448 * @param outUserName the out user name of this message boards mailing list 449 */ 450 public void setOutUserName(String outUserName); 451 452 /** 453 * Returns the out password of this message boards mailing list. 454 * 455 * @return the out password of this message boards mailing list 456 */ 457 @AutoEscape 458 public String getOutPassword(); 459 460 /** 461 * Sets the out password of this message boards mailing list. 462 * 463 * @param outPassword the out password of this message boards mailing list 464 */ 465 public void setOutPassword(String outPassword); 466 467 /** 468 * Returns the allow anonymous of this message boards mailing list. 469 * 470 * @return the allow anonymous of this message boards mailing list 471 */ 472 public boolean getAllowAnonymous(); 473 474 /** 475 * Returns <code>true</code> if this message boards mailing list is allow anonymous. 476 * 477 * @return <code>true</code> if this message boards mailing list is allow anonymous; <code>false</code> otherwise 478 */ 479 public boolean isAllowAnonymous(); 480 481 /** 482 * Sets whether this message boards mailing list is allow anonymous. 483 * 484 * @param allowAnonymous the allow anonymous of this message boards mailing list 485 */ 486 public void setAllowAnonymous(boolean allowAnonymous); 487 488 /** 489 * Returns the active of this message boards mailing list. 490 * 491 * @return the active of this message boards mailing list 492 */ 493 public boolean getActive(); 494 495 /** 496 * Returns <code>true</code> if this message boards mailing list is active. 497 * 498 * @return <code>true</code> if this message boards mailing list is active; <code>false</code> otherwise 499 */ 500 public boolean isActive(); 501 502 /** 503 * Sets whether this message boards mailing list is active. 504 * 505 * @param active the active of this message boards mailing list 506 */ 507 public void setActive(boolean active); 508 509 @Override 510 public boolean isNew(); 511 512 @Override 513 public void setNew(boolean n); 514 515 @Override 516 public boolean isCachedModel(); 517 518 @Override 519 public void setCachedModel(boolean cachedModel); 520 521 @Override 522 public boolean isEscapedModel(); 523 524 @Override 525 public Serializable getPrimaryKeyObj(); 526 527 @Override 528 public void setPrimaryKeyObj(Serializable primaryKeyObj); 529 530 @Override 531 public ExpandoBridge getExpandoBridge(); 532 533 @Override 534 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 535 536 @Override 537 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 538 539 @Override 540 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 541 542 @Override 543 public Object clone(); 544 545 @Override 546 public int compareTo(MBMailingList mbMailingList); 547 548 @Override 549 public int hashCode(); 550 551 @Override 552 public CacheModel<MBMailingList> toCacheModel(); 553 554 @Override 555 public MBMailingList toEscapedModel(); 556 557 @Override 558 public MBMailingList toUnescapedModel(); 559 560 @Override 561 public String toString(); 562 563 @Override 564 public String toXmlString(); 565 }