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