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