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