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.kernel.exception.PortalException; 021 import com.liferay.portal.kernel.trash.TrashHandler; 022 import com.liferay.portal.model.BaseModel; 023 import com.liferay.portal.model.CacheModel; 024 import com.liferay.portal.model.ContainerModel; 025 import com.liferay.portal.model.StagedGroupedModel; 026 import com.liferay.portal.model.TrashedModel; 027 import com.liferay.portal.model.WorkflowedModel; 028 import com.liferay.portal.service.ServiceContext; 029 030 import com.liferay.portlet.expando.model.ExpandoBridge; 031 import com.liferay.portlet.trash.model.TrashEntry; 032 033 import java.io.Serializable; 034 035 import java.util.Date; 036 037 /** 038 * The base model interface for the MBCategory service. Represents a row in the "MBCategory" database table, with each column mapped to a property of this class. 039 * 040 * <p> 041 * This interface and its corresponding implementation {@link com.liferay.portlet.messageboards.model.impl.MBCategoryModelImpl} 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.MBCategoryImpl}. 042 * </p> 043 * 044 * @author Brian Wing Shun Chan 045 * @see MBCategory 046 * @see com.liferay.portlet.messageboards.model.impl.MBCategoryImpl 047 * @see com.liferay.portlet.messageboards.model.impl.MBCategoryModelImpl 048 * @generated 049 */ 050 @ProviderType 051 public interface MBCategoryModel extends BaseModel<MBCategory>, ContainerModel, 052 StagedGroupedModel, TrashedModel, WorkflowedModel { 053 /* 054 * NOTE FOR DEVELOPERS: 055 * 056 * Never modify or reference this interface directly. All methods that expect a message boards category model instance should use the {@link MBCategory} interface instead. 057 */ 058 059 /** 060 * Returns the primary key of this message boards category. 061 * 062 * @return the primary key of this message boards category 063 */ 064 public long getPrimaryKey(); 065 066 /** 067 * Sets the primary key of this message boards category. 068 * 069 * @param primaryKey the primary key of this message boards category 070 */ 071 public void setPrimaryKey(long primaryKey); 072 073 /** 074 * Returns the uuid of this message boards category. 075 * 076 * @return the uuid of this message boards category 077 */ 078 @AutoEscape 079 @Override 080 public String getUuid(); 081 082 /** 083 * Sets the uuid of this message boards category. 084 * 085 * @param uuid the uuid of this message boards category 086 */ 087 @Override 088 public void setUuid(String uuid); 089 090 /** 091 * Returns the category ID of this message boards category. 092 * 093 * @return the category ID of this message boards category 094 */ 095 public long getCategoryId(); 096 097 /** 098 * Sets the category ID of this message boards category. 099 * 100 * @param categoryId the category ID of this message boards category 101 */ 102 public void setCategoryId(long categoryId); 103 104 /** 105 * Returns the group ID of this message boards category. 106 * 107 * @return the group ID of this message boards category 108 */ 109 @Override 110 public long getGroupId(); 111 112 /** 113 * Sets the group ID of this message boards category. 114 * 115 * @param groupId the group ID of this message boards category 116 */ 117 @Override 118 public void setGroupId(long groupId); 119 120 /** 121 * Returns the company ID of this message boards category. 122 * 123 * @return the company ID of this message boards category 124 */ 125 @Override 126 public long getCompanyId(); 127 128 /** 129 * Sets the company ID of this message boards category. 130 * 131 * @param companyId the company ID of this message boards category 132 */ 133 @Override 134 public void setCompanyId(long companyId); 135 136 /** 137 * Returns the user ID of this message boards category. 138 * 139 * @return the user ID of this message boards category 140 */ 141 @Override 142 public long getUserId(); 143 144 /** 145 * Sets the user ID of this message boards category. 146 * 147 * @param userId the user ID of this message boards category 148 */ 149 @Override 150 public void setUserId(long userId); 151 152 /** 153 * Returns the user uuid of this message boards category. 154 * 155 * @return the user uuid of this message boards category 156 */ 157 @Override 158 public String getUserUuid(); 159 160 /** 161 * Sets the user uuid of this message boards category. 162 * 163 * @param userUuid the user uuid of this message boards category 164 */ 165 @Override 166 public void setUserUuid(String userUuid); 167 168 /** 169 * Returns the user name of this message boards category. 170 * 171 * @return the user name of this message boards category 172 */ 173 @AutoEscape 174 @Override 175 public String getUserName(); 176 177 /** 178 * Sets the user name of this message boards category. 179 * 180 * @param userName the user name of this message boards category 181 */ 182 @Override 183 public void setUserName(String userName); 184 185 /** 186 * Returns the create date of this message boards category. 187 * 188 * @return the create date of this message boards category 189 */ 190 @Override 191 public Date getCreateDate(); 192 193 /** 194 * Sets the create date of this message boards category. 195 * 196 * @param createDate the create date of this message boards category 197 */ 198 @Override 199 public void setCreateDate(Date createDate); 200 201 /** 202 * Returns the modified date of this message boards category. 203 * 204 * @return the modified date of this message boards category 205 */ 206 @Override 207 public Date getModifiedDate(); 208 209 /** 210 * Sets the modified date of this message boards category. 211 * 212 * @param modifiedDate the modified date of this message boards category 213 */ 214 @Override 215 public void setModifiedDate(Date modifiedDate); 216 217 /** 218 * Returns the parent category ID of this message boards category. 219 * 220 * @return the parent category ID of this message boards category 221 */ 222 public long getParentCategoryId(); 223 224 /** 225 * Sets the parent category ID of this message boards category. 226 * 227 * @param parentCategoryId the parent category ID of this message boards category 228 */ 229 public void setParentCategoryId(long parentCategoryId); 230 231 /** 232 * Returns the name of this message boards category. 233 * 234 * @return the name of this message boards category 235 */ 236 @AutoEscape 237 public String getName(); 238 239 /** 240 * Sets the name of this message boards category. 241 * 242 * @param name the name of this message boards category 243 */ 244 public void setName(String name); 245 246 /** 247 * Returns the description of this message boards category. 248 * 249 * @return the description of this message boards category 250 */ 251 @AutoEscape 252 public String getDescription(); 253 254 /** 255 * Sets the description of this message boards category. 256 * 257 * @param description the description of this message boards category 258 */ 259 public void setDescription(String description); 260 261 /** 262 * Returns the display style of this message boards category. 263 * 264 * @return the display style of this message boards category 265 */ 266 @AutoEscape 267 public String getDisplayStyle(); 268 269 /** 270 * Sets the display style of this message boards category. 271 * 272 * @param displayStyle the display style of this message boards category 273 */ 274 public void setDisplayStyle(String displayStyle); 275 276 /** 277 * Returns the thread count of this message boards category. 278 * 279 * @return the thread count of this message boards category 280 */ 281 public int getThreadCount(); 282 283 /** 284 * Sets the thread count of this message boards category. 285 * 286 * @param threadCount the thread count of this message boards category 287 */ 288 public void setThreadCount(int threadCount); 289 290 /** 291 * Returns the message count of this message boards category. 292 * 293 * @return the message count of this message boards category 294 */ 295 public int getMessageCount(); 296 297 /** 298 * Sets the message count of this message boards category. 299 * 300 * @param messageCount the message count of this message boards category 301 */ 302 public void setMessageCount(int messageCount); 303 304 /** 305 * Returns the last post date of this message boards category. 306 * 307 * @return the last post date of this message boards category 308 */ 309 public Date getLastPostDate(); 310 311 /** 312 * Sets the last post date of this message boards category. 313 * 314 * @param lastPostDate the last post date of this message boards category 315 */ 316 public void setLastPostDate(Date lastPostDate); 317 318 /** 319 * Returns the status of this message boards category. 320 * 321 * @return the status of this message boards category 322 */ 323 @Override 324 public int getStatus(); 325 326 /** 327 * Sets the status of this message boards category. 328 * 329 * @param status the status of this message boards category 330 */ 331 @Override 332 public void setStatus(int status); 333 334 /** 335 * Returns the status by user ID of this message boards category. 336 * 337 * @return the status by user ID of this message boards category 338 */ 339 @Override 340 public long getStatusByUserId(); 341 342 /** 343 * Sets the status by user ID of this message boards category. 344 * 345 * @param statusByUserId the status by user ID of this message boards category 346 */ 347 @Override 348 public void setStatusByUserId(long statusByUserId); 349 350 /** 351 * Returns the status by user uuid of this message boards category. 352 * 353 * @return the status by user uuid of this message boards category 354 */ 355 @Override 356 public String getStatusByUserUuid(); 357 358 /** 359 * Sets the status by user uuid of this message boards category. 360 * 361 * @param statusByUserUuid the status by user uuid of this message boards category 362 */ 363 @Override 364 public void setStatusByUserUuid(String statusByUserUuid); 365 366 /** 367 * Returns the status by user name of this message boards category. 368 * 369 * @return the status by user name of this message boards category 370 */ 371 @AutoEscape 372 @Override 373 public String getStatusByUserName(); 374 375 /** 376 * Sets the status by user name of this message boards category. 377 * 378 * @param statusByUserName the status by user name of this message boards category 379 */ 380 @Override 381 public void setStatusByUserName(String statusByUserName); 382 383 /** 384 * Returns the status date of this message boards category. 385 * 386 * @return the status date of this message boards category 387 */ 388 @Override 389 public Date getStatusDate(); 390 391 /** 392 * Sets the status date of this message boards category. 393 * 394 * @param statusDate the status date of this message boards category 395 */ 396 @Override 397 public void setStatusDate(Date statusDate); 398 399 /** 400 * Returns the trash entry created when this message boards category was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this message boards category. 401 * 402 * @return the trash entry created when this message boards category was moved to the Recycle Bin 403 */ 404 @Override 405 public TrashEntry getTrashEntry() throws PortalException; 406 407 /** 408 * Returns the class primary key of the trash entry for this message boards category. 409 * 410 * @return the class primary key of the trash entry for this message boards category 411 */ 412 @Override 413 public long getTrashEntryClassPK(); 414 415 /** 416 * Returns the trash handler for this message boards category. 417 * 418 * @return the trash handler for this message boards category 419 */ 420 @Override 421 public TrashHandler getTrashHandler(); 422 423 /** 424 * Returns <code>true</code> if this message boards category is in the Recycle Bin. 425 * 426 * @return <code>true</code> if this message boards category is in the Recycle Bin; <code>false</code> otherwise 427 */ 428 @Override 429 public boolean isInTrash(); 430 431 /** 432 * Returns <code>true</code> if the parent of this message boards category is in the Recycle Bin. 433 * 434 * @return <code>true</code> if the parent of this message boards category is in the Recycle Bin; <code>false</code> otherwise 435 */ 436 @Override 437 public boolean isInTrashContainer(); 438 439 @Override 440 public boolean isInTrashExplicitly(); 441 442 @Override 443 public boolean isInTrashImplicitly(); 444 445 /** 446 * @deprecated As of 6.1.0, replaced by {@link #isApproved()} 447 */ 448 @Deprecated 449 @Override 450 public boolean getApproved(); 451 452 /** 453 * Returns <code>true</code> if this message boards category is approved. 454 * 455 * @return <code>true</code> if this message boards category is approved; <code>false</code> otherwise 456 */ 457 @Override 458 public boolean isApproved(); 459 460 /** 461 * Returns <code>true</code> if this message boards category is denied. 462 * 463 * @return <code>true</code> if this message boards category is denied; <code>false</code> otherwise 464 */ 465 @Override 466 public boolean isDenied(); 467 468 /** 469 * Returns <code>true</code> if this message boards category is a draft. 470 * 471 * @return <code>true</code> if this message boards category is a draft; <code>false</code> otherwise 472 */ 473 @Override 474 public boolean isDraft(); 475 476 /** 477 * Returns <code>true</code> if this message boards category is expired. 478 * 479 * @return <code>true</code> if this message boards category is expired; <code>false</code> otherwise 480 */ 481 @Override 482 public boolean isExpired(); 483 484 /** 485 * Returns <code>true</code> if this message boards category is inactive. 486 * 487 * @return <code>true</code> if this message boards category is inactive; <code>false</code> otherwise 488 */ 489 @Override 490 public boolean isInactive(); 491 492 /** 493 * Returns <code>true</code> if this message boards category is incomplete. 494 * 495 * @return <code>true</code> if this message boards category is incomplete; <code>false</code> otherwise 496 */ 497 @Override 498 public boolean isIncomplete(); 499 500 /** 501 * Returns <code>true</code> if this message boards category is pending. 502 * 503 * @return <code>true</code> if this message boards category is pending; <code>false</code> otherwise 504 */ 505 @Override 506 public boolean isPending(); 507 508 /** 509 * Returns <code>true</code> if this message boards category is scheduled. 510 * 511 * @return <code>true</code> if this message boards category is scheduled; <code>false</code> otherwise 512 */ 513 @Override 514 public boolean isScheduled(); 515 516 /** 517 * Returns the container model ID of this message boards category. 518 * 519 * @return the container model ID of this message boards category 520 */ 521 @Override 522 public long getContainerModelId(); 523 524 /** 525 * Sets the container model ID of this message boards category. 526 * 527 * @param containerModelId the container model ID of this message boards category 528 */ 529 @Override 530 public void setContainerModelId(long containerModelId); 531 532 /** 533 * Returns the container name of this message boards category. 534 * 535 * @return the container name of this message boards category 536 */ 537 @Override 538 public String getContainerModelName(); 539 540 /** 541 * Returns the parent container model ID of this message boards category. 542 * 543 * @return the parent container model ID of this message boards category 544 */ 545 @Override 546 public long getParentContainerModelId(); 547 548 /** 549 * Sets the parent container model ID of this message boards category. 550 * 551 * @param parentContainerModelId the parent container model ID of this message boards category 552 */ 553 @Override 554 public void setParentContainerModelId(long parentContainerModelId); 555 556 @Override 557 public boolean isNew(); 558 559 @Override 560 public void setNew(boolean n); 561 562 @Override 563 public boolean isCachedModel(); 564 565 @Override 566 public void setCachedModel(boolean cachedModel); 567 568 @Override 569 public boolean isEscapedModel(); 570 571 @Override 572 public Serializable getPrimaryKeyObj(); 573 574 @Override 575 public void setPrimaryKeyObj(Serializable primaryKeyObj); 576 577 @Override 578 public ExpandoBridge getExpandoBridge(); 579 580 @Override 581 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 582 583 @Override 584 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 585 586 @Override 587 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 588 589 @Override 590 public Object clone(); 591 592 @Override 593 public int compareTo( 594 com.liferay.portlet.messageboards.model.MBCategory mbCategory); 595 596 @Override 597 public int hashCode(); 598 599 @Override 600 public CacheModel<com.liferay.portlet.messageboards.model.MBCategory> toCacheModel(); 601 602 @Override 603 public com.liferay.portlet.messageboards.model.MBCategory toEscapedModel(); 604 605 @Override 606 public com.liferay.portlet.messageboards.model.MBCategory toUnescapedModel(); 607 608 @Override 609 public String toString(); 610 611 @Override 612 public String toXmlString(); 613 }