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 file entry ID of this blogs entry.
364             *
365             * @return the cover image file entry ID of this blogs entry
366             */
367            public long getCoverImageFileEntryId();
368    
369            /**
370             * Sets the cover image file entry ID of this blogs entry.
371             *
372             * @param coverImageFileEntryId the cover image file entry ID of this blogs entry
373             */
374            public void setCoverImageFileEntryId(long coverImageFileEntryId);
375    
376            /**
377             * Returns the cover image u r l of this blogs entry.
378             *
379             * @return the cover image u r l of this blogs entry
380             */
381            @AutoEscape
382            public String getCoverImageURL();
383    
384            /**
385             * Sets the cover image u r l of this blogs entry.
386             *
387             * @param coverImageURL the cover image u r l of this blogs entry
388             */
389            public void setCoverImageURL(String coverImageURL);
390    
391            /**
392             * Returns the small image of this blogs entry.
393             *
394             * @return the small image of this blogs entry
395             */
396            public boolean getSmallImage();
397    
398            /**
399             * Returns <code>true</code> if this blogs entry is small image.
400             *
401             * @return <code>true</code> if this blogs entry is small image; <code>false</code> otherwise
402             */
403            public boolean isSmallImage();
404    
405            /**
406             * Sets whether this blogs entry is small image.
407             *
408             * @param smallImage the small image of this blogs entry
409             */
410            public void setSmallImage(boolean smallImage);
411    
412            /**
413             * Returns the small image file entry ID of this blogs entry.
414             *
415             * @return the small image file entry ID of this blogs entry
416             */
417            public long getSmallImageFileEntryId();
418    
419            /**
420             * Sets the small image file entry ID of this blogs entry.
421             *
422             * @param smallImageFileEntryId the small image file entry ID of this blogs entry
423             */
424            public void setSmallImageFileEntryId(long smallImageFileEntryId);
425    
426            /**
427             * Returns the small image ID of this blogs entry.
428             *
429             * @return the small image ID of this blogs entry
430             */
431            public long getSmallImageId();
432    
433            /**
434             * Sets the small image ID of this blogs entry.
435             *
436             * @param smallImageId the small image ID of this blogs entry
437             */
438            public void setSmallImageId(long smallImageId);
439    
440            /**
441             * Returns the small image u r l of this blogs entry.
442             *
443             * @return the small image u r l of this blogs entry
444             */
445            @AutoEscape
446            public String getSmallImageURL();
447    
448            /**
449             * Sets the small image u r l of this blogs entry.
450             *
451             * @param smallImageURL the small image u r l of this blogs entry
452             */
453            public void setSmallImageURL(String smallImageURL);
454    
455            /**
456             * Returns the status of this blogs entry.
457             *
458             * @return the status of this blogs entry
459             */
460            @Override
461            public int getStatus();
462    
463            /**
464             * Sets the status of this blogs entry.
465             *
466             * @param status the status of this blogs entry
467             */
468            @Override
469            public void setStatus(int status);
470    
471            /**
472             * Returns the status by user ID of this blogs entry.
473             *
474             * @return the status by user ID of this blogs entry
475             */
476            @Override
477            public long getStatusByUserId();
478    
479            /**
480             * Sets the status by user ID of this blogs entry.
481             *
482             * @param statusByUserId the status by user ID of this blogs entry
483             */
484            @Override
485            public void setStatusByUserId(long statusByUserId);
486    
487            /**
488             * Returns the status by user uuid of this blogs entry.
489             *
490             * @return the status by user uuid of this blogs entry
491             */
492            @Override
493            public String getStatusByUserUuid();
494    
495            /**
496             * Sets the status by user uuid of this blogs entry.
497             *
498             * @param statusByUserUuid the status by user uuid of this blogs entry
499             */
500            @Override
501            public void setStatusByUserUuid(String statusByUserUuid);
502    
503            /**
504             * Returns the status by user name of this blogs entry.
505             *
506             * @return the status by user name of this blogs entry
507             */
508            @AutoEscape
509            @Override
510            public String getStatusByUserName();
511    
512            /**
513             * Sets the status by user name of this blogs entry.
514             *
515             * @param statusByUserName the status by user name of this blogs entry
516             */
517            @Override
518            public void setStatusByUserName(String statusByUserName);
519    
520            /**
521             * Returns the status date of this blogs entry.
522             *
523             * @return the status date of this blogs entry
524             */
525            @Override
526            public Date getStatusDate();
527    
528            /**
529             * Sets the status date of this blogs entry.
530             *
531             * @param statusDate the status date of this blogs entry
532             */
533            @Override
534            public void setStatusDate(Date statusDate);
535    
536            /**
537             * 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.
538             *
539             * @return the trash entry created when this blogs entry was moved to the Recycle Bin
540             */
541            @Override
542            public TrashEntry getTrashEntry() throws PortalException;
543    
544            /**
545             * Returns the class primary key of the trash entry for this blogs entry.
546             *
547             * @return the class primary key of the trash entry for this blogs entry
548             */
549            @Override
550            public long getTrashEntryClassPK();
551    
552            /**
553             * Returns the trash handler for this blogs entry.
554             *
555             * @return the trash handler for this blogs entry
556             */
557            @Override
558            public TrashHandler getTrashHandler();
559    
560            /**
561             * Returns <code>true</code> if this blogs entry is in the Recycle Bin.
562             *
563             * @return <code>true</code> if this blogs entry is in the Recycle Bin; <code>false</code> otherwise
564             */
565            @Override
566            public boolean isInTrash();
567    
568            /**
569             * Returns <code>true</code> if the parent of this blogs entry is in the Recycle Bin.
570             *
571             * @return <code>true</code> if the parent of this blogs entry is in the Recycle Bin; <code>false</code> otherwise
572             */
573            @Override
574            public boolean isInTrashContainer();
575    
576            @Override
577            public boolean isInTrashExplicitly();
578    
579            @Override
580            public boolean isInTrashImplicitly();
581    
582            /**
583             * @deprecated As of 6.1.0, replaced by {@link #isApproved()}
584             */
585            @Deprecated
586            @Override
587            public boolean getApproved();
588    
589            /**
590             * Returns <code>true</code> if this blogs entry is approved.
591             *
592             * @return <code>true</code> if this blogs entry is approved; <code>false</code> otherwise
593             */
594            @Override
595            public boolean isApproved();
596    
597            /**
598             * Returns <code>true</code> if this blogs entry is denied.
599             *
600             * @return <code>true</code> if this blogs entry is denied; <code>false</code> otherwise
601             */
602            @Override
603            public boolean isDenied();
604    
605            /**
606             * Returns <code>true</code> if this blogs entry is a draft.
607             *
608             * @return <code>true</code> if this blogs entry is a draft; <code>false</code> otherwise
609             */
610            @Override
611            public boolean isDraft();
612    
613            /**
614             * Returns <code>true</code> if this blogs entry is expired.
615             *
616             * @return <code>true</code> if this blogs entry is expired; <code>false</code> otherwise
617             */
618            @Override
619            public boolean isExpired();
620    
621            /**
622             * Returns <code>true</code> if this blogs entry is inactive.
623             *
624             * @return <code>true</code> if this blogs entry is inactive; <code>false</code> otherwise
625             */
626            @Override
627            public boolean isInactive();
628    
629            /**
630             * Returns <code>true</code> if this blogs entry is incomplete.
631             *
632             * @return <code>true</code> if this blogs entry is incomplete; <code>false</code> otherwise
633             */
634            @Override
635            public boolean isIncomplete();
636    
637            /**
638             * Returns <code>true</code> if this blogs entry is pending.
639             *
640             * @return <code>true</code> if this blogs entry is pending; <code>false</code> otherwise
641             */
642            @Override
643            public boolean isPending();
644    
645            /**
646             * Returns <code>true</code> if this blogs entry is scheduled.
647             *
648             * @return <code>true</code> if this blogs entry is scheduled; <code>false</code> otherwise
649             */
650            @Override
651            public boolean isScheduled();
652    
653            @Override
654            public boolean isNew();
655    
656            @Override
657            public void setNew(boolean n);
658    
659            @Override
660            public boolean isCachedModel();
661    
662            @Override
663            public void setCachedModel(boolean cachedModel);
664    
665            @Override
666            public boolean isEscapedModel();
667    
668            @Override
669            public Serializable getPrimaryKeyObj();
670    
671            @Override
672            public void setPrimaryKeyObj(Serializable primaryKeyObj);
673    
674            @Override
675            public ExpandoBridge getExpandoBridge();
676    
677            @Override
678            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
679    
680            @Override
681            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
682    
683            @Override
684            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
685    
686            @Override
687            public Object clone();
688    
689            @Override
690            public int compareTo(com.liferay.portlet.blogs.model.BlogsEntry blogsEntry);
691    
692            @Override
693            public int hashCode();
694    
695            @Override
696            public CacheModel<com.liferay.portlet.blogs.model.BlogsEntry> toCacheModel();
697    
698            @Override
699            public com.liferay.portlet.blogs.model.BlogsEntry toEscapedModel();
700    
701            @Override
702            public com.liferay.portlet.blogs.model.BlogsEntry toUnescapedModel();
703    
704            @Override
705            public String toString();
706    
707            @Override
708            public String toXmlString();
709    }