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