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