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