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 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.exception.SystemException;
022    import com.liferay.portal.kernel.trash.TrashHandler;
023    import com.liferay.portal.model.BaseModel;
024    import com.liferay.portal.model.CacheModel;
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>, ResourcedModel,
053            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             * @throws SystemException if a system exception occurred
177             */
178            @Override
179            public String getUserUuid() throws SystemException;
180    
181            /**
182             * Sets the user uuid of this wiki page.
183             *
184             * @param userUuid the user uuid of this wiki page
185             */
186            @Override
187            public void setUserUuid(String userUuid);
188    
189            /**
190             * Returns the user name of this wiki page.
191             *
192             * @return the user name of this wiki page
193             */
194            @AutoEscape
195            @Override
196            public String getUserName();
197    
198            /**
199             * Sets the user name of this wiki page.
200             *
201             * @param userName the user name of this wiki page
202             */
203            @Override
204            public void setUserName(String userName);
205    
206            /**
207             * Returns the create date of this wiki page.
208             *
209             * @return the create date of this wiki page
210             */
211            @Override
212            public Date getCreateDate();
213    
214            /**
215             * Sets the create date of this wiki page.
216             *
217             * @param createDate the create date of this wiki page
218             */
219            @Override
220            public void setCreateDate(Date createDate);
221    
222            /**
223             * Returns the modified date of this wiki page.
224             *
225             * @return the modified date of this wiki page
226             */
227            @Override
228            public Date getModifiedDate();
229    
230            /**
231             * Sets the modified date of this wiki page.
232             *
233             * @param modifiedDate the modified date of this wiki page
234             */
235            @Override
236            public void setModifiedDate(Date modifiedDate);
237    
238            /**
239             * Returns the node ID of this wiki page.
240             *
241             * @return the node ID of this wiki page
242             */
243            public long getNodeId();
244    
245            /**
246             * Sets the node ID of this wiki page.
247             *
248             * @param nodeId the node ID of this wiki page
249             */
250            public void setNodeId(long nodeId);
251    
252            /**
253             * Returns the title of this wiki page.
254             *
255             * @return the title of this wiki page
256             */
257            @AutoEscape
258            public String getTitle();
259    
260            /**
261             * Sets the title of this wiki page.
262             *
263             * @param title the title of this wiki page
264             */
265            public void setTitle(String title);
266    
267            /**
268             * Returns the version of this wiki page.
269             *
270             * @return the version of this wiki page
271             */
272            public double getVersion();
273    
274            /**
275             * Sets the version of this wiki page.
276             *
277             * @param version the version of this wiki page
278             */
279            public void setVersion(double version);
280    
281            /**
282             * Returns the minor edit of this wiki page.
283             *
284             * @return the minor edit of this wiki page
285             */
286            public boolean getMinorEdit();
287    
288            /**
289             * Returns <code>true</code> if this wiki page is minor edit.
290             *
291             * @return <code>true</code> if this wiki page is minor edit; <code>false</code> otherwise
292             */
293            public boolean isMinorEdit();
294    
295            /**
296             * Sets whether this wiki page is minor edit.
297             *
298             * @param minorEdit the minor edit of this wiki page
299             */
300            public void setMinorEdit(boolean minorEdit);
301    
302            /**
303             * Returns the content of this wiki page.
304             *
305             * @return the content of this wiki page
306             */
307            @AutoEscape
308            public String getContent();
309    
310            /**
311             * Sets the content of this wiki page.
312             *
313             * @param content the content of this wiki page
314             */
315            public void setContent(String content);
316    
317            /**
318             * Returns the summary of this wiki page.
319             *
320             * @return the summary of this wiki page
321             */
322            @AutoEscape
323            public String getSummary();
324    
325            /**
326             * Sets the summary of this wiki page.
327             *
328             * @param summary the summary of this wiki page
329             */
330            public void setSummary(String summary);
331    
332            /**
333             * Returns the format of this wiki page.
334             *
335             * @return the format of this wiki page
336             */
337            @AutoEscape
338            public String getFormat();
339    
340            /**
341             * Sets the format of this wiki page.
342             *
343             * @param format the format of this wiki page
344             */
345            public void setFormat(String format);
346    
347            /**
348             * Returns the head of this wiki page.
349             *
350             * @return the head of this wiki page
351             */
352            public boolean getHead();
353    
354            /**
355             * Returns <code>true</code> if this wiki page is head.
356             *
357             * @return <code>true</code> if this wiki page is head; <code>false</code> otherwise
358             */
359            public boolean isHead();
360    
361            /**
362             * Sets whether this wiki page is head.
363             *
364             * @param head the head of this wiki page
365             */
366            public void setHead(boolean head);
367    
368            /**
369             * Returns the parent title of this wiki page.
370             *
371             * @return the parent title of this wiki page
372             */
373            @AutoEscape
374            public String getParentTitle();
375    
376            /**
377             * Sets the parent title of this wiki page.
378             *
379             * @param parentTitle the parent title of this wiki page
380             */
381            public void setParentTitle(String parentTitle);
382    
383            /**
384             * Returns the redirect title of this wiki page.
385             *
386             * @return the redirect title of this wiki page
387             */
388            @AutoEscape
389            public String getRedirectTitle();
390    
391            /**
392             * Sets the redirect title of this wiki page.
393             *
394             * @param redirectTitle the redirect title of this wiki page
395             */
396            public void setRedirectTitle(String redirectTitle);
397    
398            /**
399             * Returns the status of this wiki page.
400             *
401             * @return the status of this wiki page
402             */
403            @Override
404            public int getStatus();
405    
406            /**
407             * Sets the status of this wiki page.
408             *
409             * @param status the status of this wiki page
410             */
411            @Override
412            public void setStatus(int status);
413    
414            /**
415             * Returns the status by user ID of this wiki page.
416             *
417             * @return the status by user ID of this wiki page
418             */
419            @Override
420            public long getStatusByUserId();
421    
422            /**
423             * Sets the status by user ID of this wiki page.
424             *
425             * @param statusByUserId the status by user ID of this wiki page
426             */
427            @Override
428            public void setStatusByUserId(long statusByUserId);
429    
430            /**
431             * Returns the status by user uuid of this wiki page.
432             *
433             * @return the status by user uuid of this wiki page
434             * @throws SystemException if a system exception occurred
435             */
436            @Override
437            public String getStatusByUserUuid() throws SystemException;
438    
439            /**
440             * Sets the status by user uuid of this wiki page.
441             *
442             * @param statusByUserUuid the status by user uuid of this wiki page
443             */
444            @Override
445            public void setStatusByUserUuid(String statusByUserUuid);
446    
447            /**
448             * Returns the status by user name of this wiki page.
449             *
450             * @return the status by user name of this wiki page
451             */
452            @AutoEscape
453            @Override
454            public String getStatusByUserName();
455    
456            /**
457             * Sets the status by user name of this wiki page.
458             *
459             * @param statusByUserName the status by user name of this wiki page
460             */
461            @Override
462            public void setStatusByUserName(String statusByUserName);
463    
464            /**
465             * Returns the status date of this wiki page.
466             *
467             * @return the status date of this wiki page
468             */
469            @Override
470            public Date getStatusDate();
471    
472            /**
473             * Sets the status date of this wiki page.
474             *
475             * @param statusDate the status date of this wiki page
476             */
477            @Override
478            public void setStatusDate(Date statusDate);
479    
480            /**
481             * 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.
482             *
483             * @return the trash entry created when this wiki page was moved to the Recycle Bin
484             * @throws SystemException if a system exception occurred
485             */
486            @Override
487            public TrashEntry getTrashEntry() throws PortalException, SystemException;
488    
489            /**
490             * Returns the class primary key of the trash entry for this wiki page.
491             *
492             * @return the class primary key of the trash entry for this wiki page
493             */
494            @Override
495            public long getTrashEntryClassPK();
496    
497            /**
498             * Returns the trash handler for this wiki page.
499             *
500             * @return the trash handler for this wiki page
501             */
502            @Override
503            public TrashHandler getTrashHandler();
504    
505            /**
506             * Returns <code>true</code> if this wiki page is in the Recycle Bin.
507             *
508             * @return <code>true</code> if this wiki page is in the Recycle Bin; <code>false</code> otherwise
509             */
510            @Override
511            public boolean isInTrash();
512    
513            /**
514             * Returns <code>true</code> if the parent of this wiki page is in the Recycle Bin.
515             *
516             * @return <code>true</code> if the parent of this wiki page is in the Recycle Bin; <code>false</code> otherwise
517             * @throws SystemException if a system exception occurred
518             */
519            @Override
520            public boolean isInTrashContainer();
521    
522            /**
523             * @deprecated As of 6.1.0, replaced by {@link #isApproved()}
524             */
525            @Override
526            public boolean getApproved();
527    
528            /**
529             * Returns <code>true</code> if this wiki page is approved.
530             *
531             * @return <code>true</code> if this wiki page is approved; <code>false</code> otherwise
532             */
533            @Override
534            public boolean isApproved();
535    
536            /**
537             * Returns <code>true</code> if this wiki page is denied.
538             *
539             * @return <code>true</code> if this wiki page is denied; <code>false</code> otherwise
540             */
541            @Override
542            public boolean isDenied();
543    
544            /**
545             * Returns <code>true</code> if this wiki page is a draft.
546             *
547             * @return <code>true</code> if this wiki page is a draft; <code>false</code> otherwise
548             */
549            @Override
550            public boolean isDraft();
551    
552            /**
553             * Returns <code>true</code> if this wiki page is expired.
554             *
555             * @return <code>true</code> if this wiki page is expired; <code>false</code> otherwise
556             */
557            @Override
558            public boolean isExpired();
559    
560            /**
561             * Returns <code>true</code> if this wiki page is inactive.
562             *
563             * @return <code>true</code> if this wiki page is inactive; <code>false</code> otherwise
564             */
565            @Override
566            public boolean isInactive();
567    
568            /**
569             * Returns <code>true</code> if this wiki page is incomplete.
570             *
571             * @return <code>true</code> if this wiki page is incomplete; <code>false</code> otherwise
572             */
573            @Override
574            public boolean isIncomplete();
575    
576            /**
577             * Returns <code>true</code> if this wiki page is pending.
578             *
579             * @return <code>true</code> if this wiki page is pending; <code>false</code> otherwise
580             */
581            @Override
582            public boolean isPending();
583    
584            /**
585             * Returns <code>true</code> if this wiki page is scheduled.
586             *
587             * @return <code>true</code> if this wiki page is scheduled; <code>false</code> otherwise
588             */
589            @Override
590            public boolean isScheduled();
591    
592            @Override
593            public boolean isNew();
594    
595            @Override
596            public void setNew(boolean n);
597    
598            @Override
599            public boolean isCachedModel();
600    
601            @Override
602            public void setCachedModel(boolean cachedModel);
603    
604            @Override
605            public boolean isEscapedModel();
606    
607            @Override
608            public Serializable getPrimaryKeyObj();
609    
610            @Override
611            public void setPrimaryKeyObj(Serializable primaryKeyObj);
612    
613            @Override
614            public ExpandoBridge getExpandoBridge();
615    
616            @Override
617            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
618    
619            @Override
620            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
621    
622            @Override
623            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
624    
625            @Override
626            public Object clone();
627    
628            @Override
629            public int compareTo(WikiPage wikiPage);
630    
631            @Override
632            public int hashCode();
633    
634            @Override
635            public CacheModel<WikiPage> toCacheModel();
636    
637            @Override
638            public WikiPage toEscapedModel();
639    
640            @Override
641            public WikiPage toUnescapedModel();
642    
643            @Override
644            public String toString();
645    
646            @Override
647            public String toXmlString();
648    }