001 /** 002 * Copyright (c) 2000-2010 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.annotation.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.model.BaseModel; 020 import com.liferay.portal.service.ServiceContext; 021 022 import com.liferay.portlet.expando.model.ExpandoBridge; 023 024 import java.io.Serializable; 025 026 import java.util.Date; 027 028 /** 029 * The base model interface for the JournalArticle service. Represents a row in the "JournalArticle" database table, with each column mapped to a property of this class. 030 * 031 * <p> 032 * This interface and its corresponding implementation {@link com.liferay.portlet.journal.model.impl.JournalArticleModelImpl} 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.JournalArticleImpl}. 033 * </p> 034 * 035 * <p> 036 * Never modify or reference this interface directly. All methods that expect a journal article model instance should use the {@link JournalArticle} interface instead. 037 * </p> 038 * 039 * @author Brian Wing Shun Chan 040 * @see JournalArticle 041 * @see com.liferay.portlet.journal.model.impl.JournalArticleImpl 042 * @see com.liferay.portlet.journal.model.impl.JournalArticleModelImpl 043 * @generated 044 */ 045 public interface JournalArticleModel extends BaseModel<JournalArticle> { 046 /** 047 * Gets the primary key of this journal article. 048 * 049 * @return the primary key of this journal article 050 */ 051 public long getPrimaryKey(); 052 053 /** 054 * Sets the primary key of this journal article 055 * 056 * @param pk the primary key of this journal article 057 */ 058 public void setPrimaryKey(long pk); 059 060 /** 061 * Gets the uuid of this journal article. 062 * 063 * @return the uuid of this journal article 064 */ 065 @AutoEscape 066 public String getUuid(); 067 068 /** 069 * Sets the uuid of this journal article. 070 * 071 * @param uuid the uuid of this journal article 072 */ 073 public void setUuid(String uuid); 074 075 /** 076 * Gets the id of this journal article. 077 * 078 * @return the id of this journal article 079 */ 080 public long getId(); 081 082 /** 083 * Sets the id of this journal article. 084 * 085 * @param id the id of this journal article 086 */ 087 public void setId(long id); 088 089 /** 090 * Gets the resource prim key of this journal article. 091 * 092 * @return the resource prim key of this journal article 093 */ 094 public long getResourcePrimKey(); 095 096 /** 097 * Sets the resource prim key of this journal article. 098 * 099 * @param resourcePrimKey the resource prim key of this journal article 100 */ 101 public void setResourcePrimKey(long resourcePrimKey); 102 103 /** 104 * Gets the group id of this journal article. 105 * 106 * @return the group id of this journal article 107 */ 108 public long getGroupId(); 109 110 /** 111 * Sets the group id of this journal article. 112 * 113 * @param groupId the group id of this journal article 114 */ 115 public void setGroupId(long groupId); 116 117 /** 118 * Gets the company id of this journal article. 119 * 120 * @return the company id of this journal article 121 */ 122 public long getCompanyId(); 123 124 /** 125 * Sets the company id of this journal article. 126 * 127 * @param companyId the company id of this journal article 128 */ 129 public void setCompanyId(long companyId); 130 131 /** 132 * Gets the user id of this journal article. 133 * 134 * @return the user id of this journal article 135 */ 136 public long getUserId(); 137 138 /** 139 * Sets the user id of this journal article. 140 * 141 * @param userId the user id of this journal article 142 */ 143 public void setUserId(long userId); 144 145 /** 146 * Gets the user uuid of this journal article. 147 * 148 * @return the user uuid of this journal article 149 * @throws SystemException if a system exception occurred 150 */ 151 public String getUserUuid() throws SystemException; 152 153 /** 154 * Sets the user uuid of this journal article. 155 * 156 * @param userUuid the user uuid of this journal article 157 */ 158 public void setUserUuid(String userUuid); 159 160 /** 161 * Gets the user name of this journal article. 162 * 163 * @return the user name of this journal article 164 */ 165 @AutoEscape 166 public String getUserName(); 167 168 /** 169 * Sets the user name of this journal article. 170 * 171 * @param userName the user name of this journal article 172 */ 173 public void setUserName(String userName); 174 175 /** 176 * Gets the create date of this journal article. 177 * 178 * @return the create date of this journal article 179 */ 180 public Date getCreateDate(); 181 182 /** 183 * Sets the create date of this journal article. 184 * 185 * @param createDate the create date of this journal article 186 */ 187 public void setCreateDate(Date createDate); 188 189 /** 190 * Gets the modified date of this journal article. 191 * 192 * @return the modified date of this journal article 193 */ 194 public Date getModifiedDate(); 195 196 /** 197 * Sets the modified date of this journal article. 198 * 199 * @param modifiedDate the modified date of this journal article 200 */ 201 public void setModifiedDate(Date modifiedDate); 202 203 /** 204 * Gets the article id of this journal article. 205 * 206 * @return the article id of this journal article 207 */ 208 public String getArticleId(); 209 210 /** 211 * Sets the article id of this journal article. 212 * 213 * @param articleId the article id of this journal article 214 */ 215 public void setArticleId(String articleId); 216 217 /** 218 * Gets the version of this journal article. 219 * 220 * @return the version of this journal article 221 */ 222 public double getVersion(); 223 224 /** 225 * Sets the version of this journal article. 226 * 227 * @param version the version of this journal article 228 */ 229 public void setVersion(double version); 230 231 /** 232 * Gets the title of this journal article. 233 * 234 * @return the title of this journal article 235 */ 236 @AutoEscape 237 public String getTitle(); 238 239 /** 240 * Sets the title of this journal article. 241 * 242 * @param title the title of this journal article 243 */ 244 public void setTitle(String title); 245 246 /** 247 * Gets the url title of this journal article. 248 * 249 * @return the url title of this journal article 250 */ 251 @AutoEscape 252 public String getUrlTitle(); 253 254 /** 255 * Sets the url title of this journal article. 256 * 257 * @param urlTitle the url title of this journal article 258 */ 259 public void setUrlTitle(String urlTitle); 260 261 /** 262 * Gets the description of this journal article. 263 * 264 * @return the description of this journal article 265 */ 266 @AutoEscape 267 public String getDescription(); 268 269 /** 270 * Sets the description of this journal article. 271 * 272 * @param description the description of this journal article 273 */ 274 public void setDescription(String description); 275 276 /** 277 * Gets the content of this journal article. 278 * 279 * @return the content of this journal article 280 */ 281 @AutoEscape 282 public String getContent(); 283 284 /** 285 * Sets the content of this journal article. 286 * 287 * @param content the content of this journal article 288 */ 289 public void setContent(String content); 290 291 /** 292 * Gets the type of this journal article. 293 * 294 * @return the type of this journal article 295 */ 296 @AutoEscape 297 public String getType(); 298 299 /** 300 * Sets the type of this journal article. 301 * 302 * @param type the type of this journal article 303 */ 304 public void setType(String type); 305 306 /** 307 * Gets the structure id of this journal article. 308 * 309 * @return the structure id of this journal article 310 */ 311 public String getStructureId(); 312 313 /** 314 * Sets the structure id of this journal article. 315 * 316 * @param structureId the structure id of this journal article 317 */ 318 public void setStructureId(String structureId); 319 320 /** 321 * Gets the template id of this journal article. 322 * 323 * @return the template id of this journal article 324 */ 325 public String getTemplateId(); 326 327 /** 328 * Sets the template id of this journal article. 329 * 330 * @param templateId the template id of this journal article 331 */ 332 public void setTemplateId(String templateId); 333 334 /** 335 * Gets the display date of this journal article. 336 * 337 * @return the display date of this journal article 338 */ 339 public Date getDisplayDate(); 340 341 /** 342 * Sets the display date of this journal article. 343 * 344 * @param displayDate the display date of this journal article 345 */ 346 public void setDisplayDate(Date displayDate); 347 348 /** 349 * Gets the expiration date of this journal article. 350 * 351 * @return the expiration date of this journal article 352 */ 353 public Date getExpirationDate(); 354 355 /** 356 * Sets the expiration date of this journal article. 357 * 358 * @param expirationDate the expiration date of this journal article 359 */ 360 public void setExpirationDate(Date expirationDate); 361 362 /** 363 * Gets the review date of this journal article. 364 * 365 * @return the review date of this journal article 366 */ 367 public Date getReviewDate(); 368 369 /** 370 * Sets the review date of this journal article. 371 * 372 * @param reviewDate the review date of this journal article 373 */ 374 public void setReviewDate(Date reviewDate); 375 376 /** 377 * Gets the indexable of this journal article. 378 * 379 * @return the indexable of this journal article 380 */ 381 public boolean getIndexable(); 382 383 /** 384 * Determines whether this journal article is indexable. 385 * 386 * @return whether this journal article is indexable 387 */ 388 public boolean isIndexable(); 389 390 /** 391 * Sets whether this {$entity.humanName} is indexable. 392 * 393 * @param indexable the indexable of this journal article 394 */ 395 public void setIndexable(boolean indexable); 396 397 /** 398 * Gets the small image of this journal article. 399 * 400 * @return the small image of this journal article 401 */ 402 public boolean getSmallImage(); 403 404 /** 405 * Determines whether this journal article is small image. 406 * 407 * @return whether this journal article is small image 408 */ 409 public boolean isSmallImage(); 410 411 /** 412 * Sets whether this {$entity.humanName} is small image. 413 * 414 * @param smallImage the small image of this journal article 415 */ 416 public void setSmallImage(boolean smallImage); 417 418 /** 419 * Gets the small image id of this journal article. 420 * 421 * @return the small image id of this journal article 422 */ 423 public long getSmallImageId(); 424 425 /** 426 * Sets the small image id of this journal article. 427 * 428 * @param smallImageId the small image id of this journal article 429 */ 430 public void setSmallImageId(long smallImageId); 431 432 /** 433 * Gets the small image u r l of this journal article. 434 * 435 * @return the small image u r l of this journal article 436 */ 437 @AutoEscape 438 public String getSmallImageURL(); 439 440 /** 441 * Sets the small image u r l of this journal article. 442 * 443 * @param smallImageURL the small image u r l of this journal article 444 */ 445 public void setSmallImageURL(String smallImageURL); 446 447 /** 448 * Gets the status of this journal article. 449 * 450 * @return the status of this journal article 451 */ 452 public int getStatus(); 453 454 /** 455 * Sets the status of this journal article. 456 * 457 * @param status the status of this journal article 458 */ 459 public void setStatus(int status); 460 461 /** 462 * Gets the status by user id of this journal article. 463 * 464 * @return the status by user id of this journal article 465 */ 466 public long getStatusByUserId(); 467 468 /** 469 * Sets the status by user id of this journal article. 470 * 471 * @param statusByUserId the status by user id of this journal article 472 */ 473 public void setStatusByUserId(long statusByUserId); 474 475 /** 476 * Gets the status by user uuid of this journal article. 477 * 478 * @return the status by user uuid of this journal article 479 * @throws SystemException if a system exception occurred 480 */ 481 public String getStatusByUserUuid() throws SystemException; 482 483 /** 484 * Sets the status by user uuid of this journal article. 485 * 486 * @param statusByUserUuid the status by user uuid of this journal article 487 */ 488 public void setStatusByUserUuid(String statusByUserUuid); 489 490 /** 491 * Gets the status by user name of this journal article. 492 * 493 * @return the status by user name of this journal article 494 */ 495 @AutoEscape 496 public String getStatusByUserName(); 497 498 /** 499 * Sets the status by user name of this journal article. 500 * 501 * @param statusByUserName the status by user name of this journal article 502 */ 503 public void setStatusByUserName(String statusByUserName); 504 505 /** 506 * Gets the status date of this journal article. 507 * 508 * @return the status date of this journal article 509 */ 510 public Date getStatusDate(); 511 512 /** 513 * Sets the status date of this journal article. 514 * 515 * @param statusDate the status date of this journal article 516 */ 517 public void setStatusDate(Date statusDate); 518 519 /** 520 * Determines whether this journal article is approved. 521 * 522 * @return true if this journal article is approved; false otherwise 523 */ 524 public boolean isApproved(); 525 526 /** 527 * Determines whether this journal article is a draft. 528 * 529 * @return true if this journal article is a draft; false otherwise 530 */ 531 public boolean isDraft(); 532 533 /** 534 * Determines whether this journal article is expired. 535 * 536 * @return true if this journal article is expired; false otherwise 537 */ 538 public boolean isExpired(); 539 540 /** 541 * Determines whether this journal article is pending. 542 * 543 * @return true if this journal article is pending; false otherwise 544 */ 545 public boolean isPending(); 546 547 /** 548 * Gets a copy of this journal article as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}. 549 * 550 * @return the escaped model instance 551 * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler 552 */ 553 public JournalArticle toEscapedModel(); 554 555 public boolean isNew(); 556 557 public void setNew(boolean n); 558 559 public boolean isCachedModel(); 560 561 public void setCachedModel(boolean cachedModel); 562 563 public boolean isEscapedModel(); 564 565 public void setEscapedModel(boolean escapedModel); 566 567 public Serializable getPrimaryKeyObj(); 568 569 public ExpandoBridge getExpandoBridge(); 570 571 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 572 573 public Object clone(); 574 575 public int compareTo(JournalArticle journalArticle); 576 577 public int hashCode(); 578 579 public String toString(); 580 581 public String toXmlString(); 582 }