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