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