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