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