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