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