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