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