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