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