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