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