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.ResourcedModel;
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 WikiPage service. Represents a row in the "WikiPage" 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.WikiPageModelImpl} 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.WikiPageImpl}.
043     * </p>
044     *
045     * @author Brian Wing Shun Chan
046     * @see WikiPage
047     * @see com.liferay.portlet.wiki.model.impl.WikiPageImpl
048     * @see com.liferay.portlet.wiki.model.impl.WikiPageModelImpl
049     * @generated
050     */
051    @ProviderType
052    public interface WikiPageModel extends BaseModel<WikiPage>, ContainerModel,
053            ResourcedModel, StagedGroupedModel, TrashedModel, WorkflowedModel {
054            /*
055             * NOTE FOR DEVELOPERS:
056             *
057             * Never modify or reference this interface directly. All methods that expect a wiki page model instance should use the {@link WikiPage} interface instead.
058             */
059    
060            /**
061             * Returns the primary key of this wiki page.
062             *
063             * @return the primary key of this wiki page
064             */
065            public long getPrimaryKey();
066    
067            /**
068             * Sets the primary key of this wiki page.
069             *
070             * @param primaryKey the primary key of this wiki page
071             */
072            public void setPrimaryKey(long primaryKey);
073    
074            /**
075             * Returns the uuid of this wiki page.
076             *
077             * @return the uuid of this wiki page
078             */
079            @AutoEscape
080            @Override
081            public String getUuid();
082    
083            /**
084             * Sets the uuid of this wiki page.
085             *
086             * @param uuid the uuid of this wiki page
087             */
088            @Override
089            public void setUuid(String uuid);
090    
091            /**
092             * Returns the page ID of this wiki page.
093             *
094             * @return the page ID of this wiki page
095             */
096            public long getPageId();
097    
098            /**
099             * Sets the page ID of this wiki page.
100             *
101             * @param pageId the page ID of this wiki page
102             */
103            public void setPageId(long pageId);
104    
105            /**
106             * Returns the resource prim key of this wiki page.
107             *
108             * @return the resource prim key of this wiki page
109             */
110            @Override
111            public long getResourcePrimKey();
112    
113            /**
114             * Sets the resource prim key of this wiki page.
115             *
116             * @param resourcePrimKey the resource prim key of this wiki page
117             */
118            @Override
119            public void setResourcePrimKey(long resourcePrimKey);
120    
121            @Override
122            public boolean isResourceMain();
123    
124            /**
125             * Returns the group ID of this wiki page.
126             *
127             * @return the group ID of this wiki page
128             */
129            @Override
130            public long getGroupId();
131    
132            /**
133             * Sets the group ID of this wiki page.
134             *
135             * @param groupId the group ID of this wiki page
136             */
137            @Override
138            public void setGroupId(long groupId);
139    
140            /**
141             * Returns the company ID of this wiki page.
142             *
143             * @return the company ID of this wiki page
144             */
145            @Override
146            public long getCompanyId();
147    
148            /**
149             * Sets the company ID of this wiki page.
150             *
151             * @param companyId the company ID of this wiki page
152             */
153            @Override
154            public void setCompanyId(long companyId);
155    
156            /**
157             * Returns the user ID of this wiki page.
158             *
159             * @return the user ID of this wiki page
160             */
161            @Override
162            public long getUserId();
163    
164            /**
165             * Sets the user ID of this wiki page.
166             *
167             * @param userId the user ID of this wiki page
168             */
169            @Override
170            public void setUserId(long userId);
171    
172            /**
173             * Returns the user uuid of this wiki page.
174             *
175             * @return the user uuid of this wiki page
176             */
177            @Override
178            public String getUserUuid();
179    
180            /**
181             * Sets the user uuid of this wiki page.
182             *
183             * @param userUuid the user uuid of this wiki page
184             */
185            @Override
186            public void setUserUuid(String userUuid);
187    
188            /**
189             * Returns the user name of this wiki page.
190             *
191             * @return the user name of this wiki page
192             */
193            @AutoEscape
194            @Override
195            public String getUserName();
196    
197            /**
198             * Sets the user name of this wiki page.
199             *
200             * @param userName the user name of this wiki page
201             */
202            @Override
203            public void setUserName(String userName);
204    
205            /**
206             * Returns the create date of this wiki page.
207             *
208             * @return the create date of this wiki page
209             */
210            @Override
211            public Date getCreateDate();
212    
213            /**
214             * Sets the create date of this wiki page.
215             *
216             * @param createDate the create date of this wiki page
217             */
218            @Override
219            public void setCreateDate(Date createDate);
220    
221            /**
222             * Returns the modified date of this wiki page.
223             *
224             * @return the modified date of this wiki page
225             */
226            @Override
227            public Date getModifiedDate();
228    
229            /**
230             * Sets the modified date of this wiki page.
231             *
232             * @param modifiedDate the modified date of this wiki page
233             */
234            @Override
235            public void setModifiedDate(Date modifiedDate);
236    
237            /**
238             * Returns the node ID of this wiki page.
239             *
240             * @return the node ID of this wiki page
241             */
242            public long getNodeId();
243    
244            /**
245             * Sets the node ID of this wiki page.
246             *
247             * @param nodeId the node ID of this wiki page
248             */
249            public void setNodeId(long nodeId);
250    
251            /**
252             * Returns the title of this wiki page.
253             *
254             * @return the title of this wiki page
255             */
256            @AutoEscape
257            public String getTitle();
258    
259            /**
260             * Sets the title of this wiki page.
261             *
262             * @param title the title of this wiki page
263             */
264            public void setTitle(String title);
265    
266            /**
267             * Returns the version of this wiki page.
268             *
269             * @return the version of this wiki page
270             */
271            public double getVersion();
272    
273            /**
274             * Sets the version of this wiki page.
275             *
276             * @param version the version of this wiki page
277             */
278            public void setVersion(double version);
279    
280            /**
281             * Returns the minor edit of this wiki page.
282             *
283             * @return the minor edit of this wiki page
284             */
285            public boolean getMinorEdit();
286    
287            /**
288             * Returns <code>true</code> if this wiki page is minor edit.
289             *
290             * @return <code>true</code> if this wiki page is minor edit; <code>false</code> otherwise
291             */
292            public boolean isMinorEdit();
293    
294            /**
295             * Sets whether this wiki page is minor edit.
296             *
297             * @param minorEdit the minor edit of this wiki page
298             */
299            public void setMinorEdit(boolean minorEdit);
300    
301            /**
302             * Returns the content of this wiki page.
303             *
304             * @return the content of this wiki page
305             */
306            @AutoEscape
307            public String getContent();
308    
309            /**
310             * Sets the content of this wiki page.
311             *
312             * @param content the content of this wiki page
313             */
314            public void setContent(String content);
315    
316            /**
317             * Returns the summary of this wiki page.
318             *
319             * @return the summary of this wiki page
320             */
321            @AutoEscape
322            public String getSummary();
323    
324            /**
325             * Sets the summary of this wiki page.
326             *
327             * @param summary the summary of this wiki page
328             */
329            public void setSummary(String summary);
330    
331            /**
332             * Returns the format of this wiki page.
333             *
334             * @return the format of this wiki page
335             */
336            @AutoEscape
337            public String getFormat();
338    
339            /**
340             * Sets the format of this wiki page.
341             *
342             * @param format the format of this wiki page
343             */
344            public void setFormat(String format);
345    
346            /**
347             * Returns the head of this wiki page.
348             *
349             * @return the head of this wiki page
350             */
351            public boolean getHead();
352    
353            /**
354             * Returns <code>true</code> if this wiki page is head.
355             *
356             * @return <code>true</code> if this wiki page is head; <code>false</code> otherwise
357             */
358            public boolean isHead();
359    
360            /**
361             * Sets whether this wiki page is head.
362             *
363             * @param head the head of this wiki page
364             */
365            public void setHead(boolean head);
366    
367            /**
368             * Returns the parent title of this wiki page.
369             *
370             * @return the parent title of this wiki page
371             */
372            @AutoEscape
373            public String getParentTitle();
374    
375            /**
376             * Sets the parent title of this wiki page.
377             *
378             * @param parentTitle the parent title of this wiki page
379             */
380            public void setParentTitle(String parentTitle);
381    
382            /**
383             * Returns the redirect title of this wiki page.
384             *
385             * @return the redirect title of this wiki page
386             */
387            @AutoEscape
388            public String getRedirectTitle();
389    
390            /**
391             * Sets the redirect title of this wiki page.
392             *
393             * @param redirectTitle the redirect title of this wiki page
394             */
395            public void setRedirectTitle(String redirectTitle);
396    
397            /**
398             * Returns the status of this wiki page.
399             *
400             * @return the status of this wiki page
401             */
402            @Override
403            public int getStatus();
404    
405            /**
406             * Sets the status of this wiki page.
407             *
408             * @param status the status of this wiki page
409             */
410            @Override
411            public void setStatus(int status);
412    
413            /**
414             * Returns the status by user ID of this wiki page.
415             *
416             * @return the status by user ID of this wiki page
417             */
418            @Override
419            public long getStatusByUserId();
420    
421            /**
422             * Sets the status by user ID of this wiki page.
423             *
424             * @param statusByUserId the status by user ID of this wiki page
425             */
426            @Override
427            public void setStatusByUserId(long statusByUserId);
428    
429            /**
430             * Returns the status by user uuid of this wiki page.
431             *
432             * @return the status by user uuid of this wiki page
433             */
434            @Override
435            public String getStatusByUserUuid();
436    
437            /**
438             * Sets the status by user uuid of this wiki page.
439             *
440             * @param statusByUserUuid the status by user uuid of this wiki page
441             */
442            @Override
443            public void setStatusByUserUuid(String statusByUserUuid);
444    
445            /**
446             * Returns the status by user name of this wiki page.
447             *
448             * @return the status by user name of this wiki page
449             */
450            @AutoEscape
451            @Override
452            public String getStatusByUserName();
453    
454            /**
455             * Sets the status by user name of this wiki page.
456             *
457             * @param statusByUserName the status by user name of this wiki page
458             */
459            @Override
460            public void setStatusByUserName(String statusByUserName);
461    
462            /**
463             * Returns the status date of this wiki page.
464             *
465             * @return the status date of this wiki page
466             */
467            @Override
468            public Date getStatusDate();
469    
470            /**
471             * Sets the status date of this wiki page.
472             *
473             * @param statusDate the status date of this wiki page
474             */
475            @Override
476            public void setStatusDate(Date statusDate);
477    
478            /**
479             * Returns the trash entry created when this wiki page was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this wiki page.
480             *
481             * @return the trash entry created when this wiki page was moved to the Recycle Bin
482             */
483            @Override
484            public TrashEntry getTrashEntry() throws PortalException;
485    
486            /**
487             * Returns the class primary key of the trash entry for this wiki page.
488             *
489             * @return the class primary key of the trash entry for this wiki page
490             */
491            @Override
492            public long getTrashEntryClassPK();
493    
494            /**
495             * Returns the trash handler for this wiki page.
496             *
497             * @return the trash handler for this wiki page
498             */
499            @Override
500            public TrashHandler getTrashHandler();
501    
502            /**
503             * Returns <code>true</code> if this wiki page is in the Recycle Bin.
504             *
505             * @return <code>true</code> if this wiki page is in the Recycle Bin; <code>false</code> otherwise
506             */
507            @Override
508            public boolean isInTrash();
509    
510            /**
511             * Returns <code>true</code> if the parent of this wiki page is in the Recycle Bin.
512             *
513             * @return <code>true</code> if the parent of this wiki page is in the Recycle Bin; <code>false</code> otherwise
514             */
515            @Override
516            public boolean isInTrashContainer();
517    
518            @Override
519            public boolean isInTrashExplicitly();
520    
521            @Override
522            public boolean isInTrashImplicitly();
523    
524            /**
525             * @deprecated As of 6.1.0, replaced by {@link #isApproved()}
526             */
527            @Deprecated
528            @Override
529            public boolean getApproved();
530    
531            /**
532             * Returns <code>true</code> if this wiki page is approved.
533             *
534             * @return <code>true</code> if this wiki page is approved; <code>false</code> otherwise
535             */
536            @Override
537            public boolean isApproved();
538    
539            /**
540             * Returns <code>true</code> if this wiki page is denied.
541             *
542             * @return <code>true</code> if this wiki page is denied; <code>false</code> otherwise
543             */
544            @Override
545            public boolean isDenied();
546    
547            /**
548             * Returns <code>true</code> if this wiki page is a draft.
549             *
550             * @return <code>true</code> if this wiki page is a draft; <code>false</code> otherwise
551             */
552            @Override
553            public boolean isDraft();
554    
555            /**
556             * Returns <code>true</code> if this wiki page is expired.
557             *
558             * @return <code>true</code> if this wiki page is expired; <code>false</code> otherwise
559             */
560            @Override
561            public boolean isExpired();
562    
563            /**
564             * Returns <code>true</code> if this wiki page is inactive.
565             *
566             * @return <code>true</code> if this wiki page is inactive; <code>false</code> otherwise
567             */
568            @Override
569            public boolean isInactive();
570    
571            /**
572             * Returns <code>true</code> if this wiki page is incomplete.
573             *
574             * @return <code>true</code> if this wiki page is incomplete; <code>false</code> otherwise
575             */
576            @Override
577            public boolean isIncomplete();
578    
579            /**
580             * Returns <code>true</code> if this wiki page is pending.
581             *
582             * @return <code>true</code> if this wiki page is pending; <code>false</code> otherwise
583             */
584            @Override
585            public boolean isPending();
586    
587            /**
588             * Returns <code>true</code> if this wiki page is scheduled.
589             *
590             * @return <code>true</code> if this wiki page is scheduled; <code>false</code> otherwise
591             */
592            @Override
593            public boolean isScheduled();
594    
595            /**
596             * Returns the container model ID of this wiki page.
597             *
598             * @return the container model ID of this wiki page
599             */
600            @Override
601            public long getContainerModelId();
602    
603            /**
604             * Sets the container model ID of this wiki page.
605             *
606             * @param containerModelId the container model ID of this wiki page
607             */
608            @Override
609            public void setContainerModelId(long containerModelId);
610    
611            /**
612             * Returns the container name of this wiki page.
613             *
614             * @return the container name of this wiki page
615             */
616            @Override
617            public String getContainerModelName();
618    
619            /**
620             * Returns the parent container model ID of this wiki page.
621             *
622             * @return the parent container model ID of this wiki page
623             */
624            @Override
625            public long getParentContainerModelId();
626    
627            /**
628             * Sets the parent container model ID of this wiki page.
629             *
630             * @param parentContainerModelId the parent container model ID of this wiki page
631             */
632            @Override
633            public void setParentContainerModelId(long parentContainerModelId);
634    
635            @Override
636            public boolean isNew();
637    
638            @Override
639            public void setNew(boolean n);
640    
641            @Override
642            public boolean isCachedModel();
643    
644            @Override
645            public void setCachedModel(boolean cachedModel);
646    
647            @Override
648            public boolean isEscapedModel();
649    
650            @Override
651            public Serializable getPrimaryKeyObj();
652    
653            @Override
654            public void setPrimaryKeyObj(Serializable primaryKeyObj);
655    
656            @Override
657            public ExpandoBridge getExpandoBridge();
658    
659            @Override
660            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
661    
662            @Override
663            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
664    
665            @Override
666            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
667    
668            @Override
669            public Object clone();
670    
671            @Override
672            public int compareTo(com.liferay.portlet.wiki.model.WikiPage wikiPage);
673    
674            @Override
675            public int hashCode();
676    
677            @Override
678            public CacheModel<com.liferay.portlet.wiki.model.WikiPage> toCacheModel();
679    
680            @Override
681            public com.liferay.portlet.wiki.model.WikiPage toEscapedModel();
682    
683            @Override
684            public com.liferay.portlet.wiki.model.WikiPage toUnescapedModel();
685    
686            @Override
687            public String toString();
688    
689            @Override
690            public String toXmlString();
691    }