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