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