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