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