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            /**
352             * Returns the class primary key of the trash entry for this wiki node.
353             *
354             * @return the class primary key of the trash entry for this wiki node
355             */
356            @Override
357            public long getTrashEntryClassPK();
358    
359            /**
360             * Returns the trash handler for this wiki node.
361             *
362             * @return the trash handler for this wiki node
363             */
364            @Override
365            public TrashHandler getTrashHandler();
366    
367            /**
368             * Returns <code>true</code> if this wiki node is in the Recycle Bin.
369             *
370             * @return <code>true</code> if this wiki node is in the Recycle Bin; <code>false</code> otherwise
371             */
372            @Override
373            public boolean isInTrash();
374    
375            /**
376             * Returns <code>true</code> if the parent of this wiki node is in the Recycle Bin.
377             *
378             * @return <code>true</code> if the parent of this wiki node is in the Recycle Bin; <code>false</code> otherwise
379             * @throws SystemException if a system exception occurred
380             */
381            @Override
382            public boolean isInTrashContainer();
383    
384            /**
385             * @deprecated As of 6.1.0, replaced by {@link #isApproved()}
386             */
387            @Override
388            public boolean getApproved();
389    
390            /**
391             * Returns <code>true</code> if this wiki node is approved.
392             *
393             * @return <code>true</code> if this wiki node is approved; <code>false</code> otherwise
394             */
395            @Override
396            public boolean isApproved();
397    
398            /**
399             * Returns <code>true</code> if this wiki node is denied.
400             *
401             * @return <code>true</code> if this wiki node is denied; <code>false</code> otherwise
402             */
403            @Override
404            public boolean isDenied();
405    
406            /**
407             * Returns <code>true</code> if this wiki node is a draft.
408             *
409             * @return <code>true</code> if this wiki node is a draft; <code>false</code> otherwise
410             */
411            @Override
412            public boolean isDraft();
413    
414            /**
415             * Returns <code>true</code> if this wiki node is expired.
416             *
417             * @return <code>true</code> if this wiki node is expired; <code>false</code> otherwise
418             */
419            @Override
420            public boolean isExpired();
421    
422            /**
423             * Returns <code>true</code> if this wiki node is inactive.
424             *
425             * @return <code>true</code> if this wiki node is inactive; <code>false</code> otherwise
426             */
427            @Override
428            public boolean isInactive();
429    
430            /**
431             * Returns <code>true</code> if this wiki node is incomplete.
432             *
433             * @return <code>true</code> if this wiki node is incomplete; <code>false</code> otherwise
434             */
435            @Override
436            public boolean isIncomplete();
437    
438            /**
439             * Returns <code>true</code> if this wiki node is pending.
440             *
441             * @return <code>true</code> if this wiki node is pending; <code>false</code> otherwise
442             */
443            @Override
444            public boolean isPending();
445    
446            /**
447             * Returns <code>true</code> if this wiki node is scheduled.
448             *
449             * @return <code>true</code> if this wiki node is scheduled; <code>false</code> otherwise
450             */
451            @Override
452            public boolean isScheduled();
453    
454            /**
455             * Returns the container model ID of this wiki node.
456             *
457             * @return the container model ID of this wiki node
458             */
459            @Override
460            public long getContainerModelId();
461    
462            /**
463             * Sets the container model ID of this wiki node.
464             *
465             * @param containerModelId the container model ID of this wiki node
466             */
467            @Override
468            public void setContainerModelId(long containerModelId);
469    
470            /**
471             * Returns the container name of this wiki node.
472             *
473             * @return the container name of this wiki node
474             */
475            @Override
476            public String getContainerModelName();
477    
478            /**
479             * Returns the parent container model ID of this wiki node.
480             *
481             * @return the parent container model ID of this wiki node
482             */
483            @Override
484            public long getParentContainerModelId();
485    
486            /**
487             * Sets the parent container model ID of this wiki node.
488             *
489             * @param parentContainerModelId the parent container model ID of this wiki node
490             */
491            @Override
492            public void setParentContainerModelId(long parentContainerModelId);
493    
494            @Override
495            public boolean isNew();
496    
497            @Override
498            public void setNew(boolean n);
499    
500            @Override
501            public boolean isCachedModel();
502    
503            @Override
504            public void setCachedModel(boolean cachedModel);
505    
506            @Override
507            public boolean isEscapedModel();
508    
509            @Override
510            public Serializable getPrimaryKeyObj();
511    
512            @Override
513            public void setPrimaryKeyObj(Serializable primaryKeyObj);
514    
515            @Override
516            public ExpandoBridge getExpandoBridge();
517    
518            @Override
519            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
520    
521            @Override
522            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
523    
524            @Override
525            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
526    
527            @Override
528            public Object clone();
529    
530            @Override
531            public int compareTo(WikiNode wikiNode);
532    
533            @Override
534            public int hashCode();
535    
536            @Override
537            public CacheModel<WikiNode> toCacheModel();
538    
539            @Override
540            public WikiNode toEscapedModel();
541    
542            @Override
543            public WikiNode toUnescapedModel();
544    
545            @Override
546            public String toString();
547    
548            @Override
549            public String toXmlString();
550    }