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 public String getUuid(); 073 074 /** 075 * Sets the uuid of this bookmarks entry. 076 * 077 * @param uuid the uuid of this bookmarks entry 078 */ 079 public void setUuid(String uuid); 080 081 /** 082 * Returns the entry ID of this bookmarks entry. 083 * 084 * @return the entry ID of this bookmarks entry 085 */ 086 public long getEntryId(); 087 088 /** 089 * Sets the entry ID of this bookmarks entry. 090 * 091 * @param entryId the entry ID of this bookmarks entry 092 */ 093 public void setEntryId(long entryId); 094 095 /** 096 * Returns the group ID of this bookmarks entry. 097 * 098 * @return the group ID of this bookmarks entry 099 */ 100 public long getGroupId(); 101 102 /** 103 * Sets the group ID of this bookmarks entry. 104 * 105 * @param groupId the group ID of this bookmarks entry 106 */ 107 public void setGroupId(long groupId); 108 109 /** 110 * Returns the company ID of this bookmarks entry. 111 * 112 * @return the company ID of this bookmarks entry 113 */ 114 public long getCompanyId(); 115 116 /** 117 * Sets the company ID of this bookmarks entry. 118 * 119 * @param companyId the company ID of this bookmarks entry 120 */ 121 public void setCompanyId(long companyId); 122 123 /** 124 * Returns the user ID of this bookmarks entry. 125 * 126 * @return the user ID of this bookmarks entry 127 */ 128 public long getUserId(); 129 130 /** 131 * Sets the user ID of this bookmarks entry. 132 * 133 * @param userId the user ID of this bookmarks entry 134 */ 135 public void setUserId(long userId); 136 137 /** 138 * Returns the user uuid of this bookmarks entry. 139 * 140 * @return the user uuid of this bookmarks entry 141 * @throws SystemException if a system exception occurred 142 */ 143 public String getUserUuid() throws SystemException; 144 145 /** 146 * Sets the user uuid of this bookmarks entry. 147 * 148 * @param userUuid the user uuid of this bookmarks entry 149 */ 150 public void setUserUuid(String userUuid); 151 152 /** 153 * Returns the user name of this bookmarks entry. 154 * 155 * @return the user name of this bookmarks entry 156 */ 157 @AutoEscape 158 public String getUserName(); 159 160 /** 161 * Sets the user name of this bookmarks entry. 162 * 163 * @param userName the user name of this bookmarks entry 164 */ 165 public void setUserName(String userName); 166 167 /** 168 * Returns the create date of this bookmarks entry. 169 * 170 * @return the create date of this bookmarks entry 171 */ 172 public Date getCreateDate(); 173 174 /** 175 * Sets the create date of this bookmarks entry. 176 * 177 * @param createDate the create date of this bookmarks entry 178 */ 179 public void setCreateDate(Date createDate); 180 181 /** 182 * Returns the modified date of this bookmarks entry. 183 * 184 * @return the modified date of this bookmarks entry 185 */ 186 public Date getModifiedDate(); 187 188 /** 189 * Sets the modified date of this bookmarks entry. 190 * 191 * @param modifiedDate the modified date of this bookmarks entry 192 */ 193 public void setModifiedDate(Date modifiedDate); 194 195 /** 196 * Returns the resource block ID of this bookmarks entry. 197 * 198 * @return the resource block ID of this bookmarks entry 199 */ 200 public long getResourceBlockId(); 201 202 /** 203 * Sets the resource block ID of this bookmarks entry. 204 * 205 * @param resourceBlockId the resource block ID of this bookmarks entry 206 */ 207 public void setResourceBlockId(long resourceBlockId); 208 209 /** 210 * Returns the folder ID of this bookmarks entry. 211 * 212 * @return the folder ID of this bookmarks entry 213 */ 214 public long getFolderId(); 215 216 /** 217 * Sets the folder ID of this bookmarks entry. 218 * 219 * @param folderId the folder ID of this bookmarks entry 220 */ 221 public void setFolderId(long folderId); 222 223 /** 224 * Returns the name of this bookmarks entry. 225 * 226 * @return the name of this bookmarks entry 227 */ 228 @AutoEscape 229 public String getName(); 230 231 /** 232 * Sets the name of this bookmarks entry. 233 * 234 * @param name the name of this bookmarks entry 235 */ 236 public void setName(String name); 237 238 /** 239 * Returns the url of this bookmarks entry. 240 * 241 * @return the url of this bookmarks entry 242 */ 243 @AutoEscape 244 public String getUrl(); 245 246 /** 247 * Sets the url of this bookmarks entry. 248 * 249 * @param url the url of this bookmarks entry 250 */ 251 public void setUrl(String url); 252 253 /** 254 * Returns the description of this bookmarks entry. 255 * 256 * @return the description of this bookmarks entry 257 */ 258 @AutoEscape 259 public String getDescription(); 260 261 /** 262 * Sets the description of this bookmarks entry. 263 * 264 * @param description the description of this bookmarks entry 265 */ 266 public void setDescription(String description); 267 268 /** 269 * Returns the visits of this bookmarks entry. 270 * 271 * @return the visits of this bookmarks entry 272 */ 273 public int getVisits(); 274 275 /** 276 * Sets the visits of this bookmarks entry. 277 * 278 * @param visits the visits of this bookmarks entry 279 */ 280 public void setVisits(int visits); 281 282 /** 283 * Returns the priority of this bookmarks entry. 284 * 285 * @return the priority of this bookmarks entry 286 */ 287 public int getPriority(); 288 289 /** 290 * Sets the priority of this bookmarks entry. 291 * 292 * @param priority the priority of this bookmarks entry 293 */ 294 public void setPriority(int priority); 295 296 /** 297 * Returns the status of this bookmarks entry. 298 * 299 * @return the status of this bookmarks entry 300 */ 301 public int getStatus(); 302 303 /** 304 * Sets the status of this bookmarks entry. 305 * 306 * @param status the status of this bookmarks entry 307 */ 308 public void setStatus(int status); 309 310 /** 311 * Returns the status by user ID of this bookmarks entry. 312 * 313 * @return the status by user ID of this bookmarks entry 314 */ 315 public long getStatusByUserId(); 316 317 /** 318 * Sets the status by user ID of this bookmarks entry. 319 * 320 * @param statusByUserId the status by user ID of this bookmarks entry 321 */ 322 public void setStatusByUserId(long statusByUserId); 323 324 /** 325 * Returns the status by user uuid of this bookmarks entry. 326 * 327 * @return the status by user uuid of this bookmarks entry 328 * @throws SystemException if a system exception occurred 329 */ 330 public String getStatusByUserUuid() throws SystemException; 331 332 /** 333 * Sets the status by user uuid of this bookmarks entry. 334 * 335 * @param statusByUserUuid the status by user uuid of this bookmarks entry 336 */ 337 public void setStatusByUserUuid(String statusByUserUuid); 338 339 /** 340 * Returns the status by user name of this bookmarks entry. 341 * 342 * @return the status by user name of this bookmarks entry 343 */ 344 @AutoEscape 345 public String getStatusByUserName(); 346 347 /** 348 * Sets the status by user name of this bookmarks entry. 349 * 350 * @param statusByUserName the status by user name of this bookmarks entry 351 */ 352 public void setStatusByUserName(String statusByUserName); 353 354 /** 355 * Returns the status date of this bookmarks entry. 356 * 357 * @return the status date of this bookmarks entry 358 */ 359 public Date getStatusDate(); 360 361 /** 362 * Sets the status date of this bookmarks entry. 363 * 364 * @param statusDate the status date of this bookmarks entry 365 */ 366 public void setStatusDate(Date statusDate); 367 368 /** 369 * @deprecated As of 6.1.0, replaced by {@link #isApproved()} 370 */ 371 public boolean getApproved(); 372 373 /** 374 * Returns <code>true</code> if this bookmarks entry is approved. 375 * 376 * @return <code>true</code> if this bookmarks entry is approved; <code>false</code> otherwise 377 */ 378 public boolean isApproved(); 379 380 /** 381 * Returns <code>true</code> if this bookmarks entry is denied. 382 * 383 * @return <code>true</code> if this bookmarks entry is denied; <code>false</code> otherwise 384 */ 385 public boolean isDenied(); 386 387 /** 388 * Returns <code>true</code> if this bookmarks entry is a draft. 389 * 390 * @return <code>true</code> if this bookmarks entry is a draft; <code>false</code> otherwise 391 */ 392 public boolean isDraft(); 393 394 /** 395 * Returns <code>true</code> if this bookmarks entry is expired. 396 * 397 * @return <code>true</code> if this bookmarks entry is expired; <code>false</code> otherwise 398 */ 399 public boolean isExpired(); 400 401 /** 402 * Returns <code>true</code> if this bookmarks entry is inactive. 403 * 404 * @return <code>true</code> if this bookmarks entry is inactive; <code>false</code> otherwise 405 */ 406 public boolean isInactive(); 407 408 /** 409 * Returns <code>true</code> if this bookmarks entry is incomplete. 410 * 411 * @return <code>true</code> if this bookmarks entry is incomplete; <code>false</code> otherwise 412 */ 413 public boolean isIncomplete(); 414 415 /** 416 * Returns <code>true</code> if this bookmarks entry is in the Recycle Bin. 417 * 418 * @return <code>true</code> if this bookmarks entry is in the Recycle Bin; <code>false</code> otherwise 419 */ 420 public boolean isInTrash(); 421 422 /** 423 * Returns <code>true</code> if this bookmarks entry is pending. 424 * 425 * @return <code>true</code> if this bookmarks entry is pending; <code>false</code> otherwise 426 */ 427 public boolean isPending(); 428 429 /** 430 * Returns <code>true</code> if this bookmarks entry is scheduled. 431 * 432 * @return <code>true</code> if this bookmarks entry is scheduled; <code>false</code> otherwise 433 */ 434 public boolean isScheduled(); 435 436 public boolean isNew(); 437 438 public void setNew(boolean n); 439 440 public boolean isCachedModel(); 441 442 public void setCachedModel(boolean cachedModel); 443 444 public boolean isEscapedModel(); 445 446 public Serializable getPrimaryKeyObj(); 447 448 public void setPrimaryKeyObj(Serializable primaryKeyObj); 449 450 public ExpandoBridge getExpandoBridge(); 451 452 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 453 454 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 455 456 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 457 458 public Object clone(); 459 460 public int compareTo(BookmarksEntry bookmarksEntry); 461 462 public int hashCode(); 463 464 public CacheModel<BookmarksEntry> toCacheModel(); 465 466 public BookmarksEntry toEscapedModel(); 467 468 public BookmarksEntry toUnescapedModel(); 469 470 public String toString(); 471 472 public String toXmlString(); 473 }