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