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