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