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