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