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