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.journal.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.model.CacheModel;
021    import com.liferay.portal.model.ContainerModel;
022    import com.liferay.portal.model.StagedGroupedModel;
023    import com.liferay.portal.model.WorkflowedModel;
024    import com.liferay.portal.service.ServiceContext;
025    
026    import com.liferay.portlet.expando.model.ExpandoBridge;
027    
028    import java.io.Serializable;
029    
030    import java.util.Date;
031    
032    /**
033     * The base model interface for the JournalFolder service. Represents a row in the "JournalFolder" database table, with each column mapped to a property of this class.
034     *
035     * <p>
036     * This interface and its corresponding implementation {@link com.liferay.portlet.journal.model.impl.JournalFolderModelImpl} 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.journal.model.impl.JournalFolderImpl}.
037     * </p>
038     *
039     * @author Brian Wing Shun Chan
040     * @see JournalFolder
041     * @see com.liferay.portlet.journal.model.impl.JournalFolderImpl
042     * @see com.liferay.portlet.journal.model.impl.JournalFolderModelImpl
043     * @generated
044     */
045    public interface JournalFolderModel extends BaseModel<JournalFolder>,
046            ContainerModel, StagedGroupedModel, WorkflowedModel {
047            /*
048             * NOTE FOR DEVELOPERS:
049             *
050             * Never modify or reference this interface directly. All methods that expect a journal folder model instance should use the {@link JournalFolder} interface instead.
051             */
052    
053            /**
054             * Returns the primary key of this journal folder.
055             *
056             * @return the primary key of this journal folder
057             */
058            public long getPrimaryKey();
059    
060            /**
061             * Sets the primary key of this journal folder.
062             *
063             * @param primaryKey the primary key of this journal folder
064             */
065            public void setPrimaryKey(long primaryKey);
066    
067            /**
068             * Returns the uuid of this journal folder.
069             *
070             * @return the uuid of this journal folder
071             */
072            @AutoEscape
073            @Override
074            public String getUuid();
075    
076            /**
077             * Sets the uuid of this journal folder.
078             *
079             * @param uuid the uuid of this journal folder
080             */
081            @Override
082            public void setUuid(String uuid);
083    
084            /**
085             * Returns the folder ID of this journal folder.
086             *
087             * @return the folder ID of this journal folder
088             */
089            public long getFolderId();
090    
091            /**
092             * Sets the folder ID of this journal folder.
093             *
094             * @param folderId the folder ID of this journal folder
095             */
096            public void setFolderId(long folderId);
097    
098            /**
099             * Returns the group ID of this journal folder.
100             *
101             * @return the group ID of this journal folder
102             */
103            @Override
104            public long getGroupId();
105    
106            /**
107             * Sets the group ID of this journal folder.
108             *
109             * @param groupId the group ID of this journal folder
110             */
111            @Override
112            public void setGroupId(long groupId);
113    
114            /**
115             * Returns the company ID of this journal folder.
116             *
117             * @return the company ID of this journal folder
118             */
119            @Override
120            public long getCompanyId();
121    
122            /**
123             * Sets the company ID of this journal folder.
124             *
125             * @param companyId the company ID of this journal folder
126             */
127            @Override
128            public void setCompanyId(long companyId);
129    
130            /**
131             * Returns the user ID of this journal folder.
132             *
133             * @return the user ID of this journal folder
134             */
135            @Override
136            public long getUserId();
137    
138            /**
139             * Sets the user ID of this journal folder.
140             *
141             * @param userId the user ID of this journal folder
142             */
143            @Override
144            public void setUserId(long userId);
145    
146            /**
147             * Returns the user uuid of this journal folder.
148             *
149             * @return the user uuid of this journal folder
150             * @throws SystemException if a system exception occurred
151             */
152            @Override
153            public String getUserUuid() throws SystemException;
154    
155            /**
156             * Sets the user uuid of this journal folder.
157             *
158             * @param userUuid the user uuid of this journal folder
159             */
160            @Override
161            public void setUserUuid(String userUuid);
162    
163            /**
164             * Returns the user name of this journal folder.
165             *
166             * @return the user name of this journal folder
167             */
168            @AutoEscape
169            @Override
170            public String getUserName();
171    
172            /**
173             * Sets the user name of this journal folder.
174             *
175             * @param userName the user name of this journal folder
176             */
177            @Override
178            public void setUserName(String userName);
179    
180            /**
181             * Returns the create date of this journal folder.
182             *
183             * @return the create date of this journal folder
184             */
185            @Override
186            public Date getCreateDate();
187    
188            /**
189             * Sets the create date of this journal folder.
190             *
191             * @param createDate the create date of this journal folder
192             */
193            @Override
194            public void setCreateDate(Date createDate);
195    
196            /**
197             * Returns the modified date of this journal folder.
198             *
199             * @return the modified date of this journal folder
200             */
201            @Override
202            public Date getModifiedDate();
203    
204            /**
205             * Sets the modified date of this journal folder.
206             *
207             * @param modifiedDate the modified date of this journal folder
208             */
209            @Override
210            public void setModifiedDate(Date modifiedDate);
211    
212            /**
213             * Returns the parent folder ID of this journal folder.
214             *
215             * @return the parent folder ID of this journal folder
216             */
217            public long getParentFolderId();
218    
219            /**
220             * Sets the parent folder ID of this journal folder.
221             *
222             * @param parentFolderId the parent folder ID of this journal folder
223             */
224            public void setParentFolderId(long parentFolderId);
225    
226            /**
227             * Returns the name of this journal folder.
228             *
229             * @return the name of this journal folder
230             */
231            @AutoEscape
232            public String getName();
233    
234            /**
235             * Sets the name of this journal folder.
236             *
237             * @param name the name of this journal folder
238             */
239            public void setName(String name);
240    
241            /**
242             * Returns the description of this journal folder.
243             *
244             * @return the description of this journal folder
245             */
246            @AutoEscape
247            public String getDescription();
248    
249            /**
250             * Sets the description of this journal folder.
251             *
252             * @param description the description of this journal folder
253             */
254            public void setDescription(String description);
255    
256            /**
257             * Returns the status of this journal folder.
258             *
259             * @return the status of this journal folder
260             */
261            @Override
262            public int getStatus();
263    
264            /**
265             * Sets the status of this journal folder.
266             *
267             * @param status the status of this journal folder
268             */
269            @Override
270            public void setStatus(int status);
271    
272            /**
273             * Returns the status by user ID of this journal folder.
274             *
275             * @return the status by user ID of this journal folder
276             */
277            @Override
278            public long getStatusByUserId();
279    
280            /**
281             * Sets the status by user ID of this journal folder.
282             *
283             * @param statusByUserId the status by user ID of this journal folder
284             */
285            @Override
286            public void setStatusByUserId(long statusByUserId);
287    
288            /**
289             * Returns the status by user uuid of this journal folder.
290             *
291             * @return the status by user uuid of this journal folder
292             * @throws SystemException if a system exception occurred
293             */
294            @Override
295            public String getStatusByUserUuid() throws SystemException;
296    
297            /**
298             * Sets the status by user uuid of this journal folder.
299             *
300             * @param statusByUserUuid the status by user uuid of this journal folder
301             */
302            @Override
303            public void setStatusByUserUuid(String statusByUserUuid);
304    
305            /**
306             * Returns the status by user name of this journal folder.
307             *
308             * @return the status by user name of this journal folder
309             */
310            @AutoEscape
311            @Override
312            public String getStatusByUserName();
313    
314            /**
315             * Sets the status by user name of this journal folder.
316             *
317             * @param statusByUserName the status by user name of this journal folder
318             */
319            @Override
320            public void setStatusByUserName(String statusByUserName);
321    
322            /**
323             * Returns the status date of this journal folder.
324             *
325             * @return the status date of this journal folder
326             */
327            @Override
328            public Date getStatusDate();
329    
330            /**
331             * Sets the status date of this journal folder.
332             *
333             * @param statusDate the status date of this journal folder
334             */
335            @Override
336            public void setStatusDate(Date statusDate);
337    
338            /**
339             * @deprecated As of 6.1.0, replaced by {@link #isApproved()}
340             */
341            @Override
342            public boolean getApproved();
343    
344            /**
345             * Returns <code>true</code> if this journal folder is approved.
346             *
347             * @return <code>true</code> if this journal folder is approved; <code>false</code> otherwise
348             */
349            @Override
350            public boolean isApproved();
351    
352            /**
353             * Returns <code>true</code> if this journal folder is denied.
354             *
355             * @return <code>true</code> if this journal folder is denied; <code>false</code> otherwise
356             */
357            @Override
358            public boolean isDenied();
359    
360            /**
361             * Returns <code>true</code> if this journal folder is a draft.
362             *
363             * @return <code>true</code> if this journal folder is a draft; <code>false</code> otherwise
364             */
365            @Override
366            public boolean isDraft();
367    
368            /**
369             * Returns <code>true</code> if this journal folder is expired.
370             *
371             * @return <code>true</code> if this journal folder is expired; <code>false</code> otherwise
372             */
373            @Override
374            public boolean isExpired();
375    
376            /**
377             * Returns <code>true</code> if this journal folder is inactive.
378             *
379             * @return <code>true</code> if this journal folder is inactive; <code>false</code> otherwise
380             */
381            @Override
382            public boolean isInactive();
383    
384            /**
385             * Returns <code>true</code> if this journal folder is incomplete.
386             *
387             * @return <code>true</code> if this journal folder is incomplete; <code>false</code> otherwise
388             */
389            @Override
390            public boolean isIncomplete();
391    
392            /**
393             * Returns <code>true</code> if this journal folder is in the Recycle Bin.
394             *
395             * @return <code>true</code> if this journal folder is in the Recycle Bin; <code>false</code> otherwise
396             */
397            @Override
398            public boolean isInTrash();
399    
400            /**
401             * Returns <code>true</code> if this journal folder is pending.
402             *
403             * @return <code>true</code> if this journal folder is pending; <code>false</code> otherwise
404             */
405            @Override
406            public boolean isPending();
407    
408            /**
409             * Returns <code>true</code> if this journal folder is scheduled.
410             *
411             * @return <code>true</code> if this journal folder is scheduled; <code>false</code> otherwise
412             */
413            @Override
414            public boolean isScheduled();
415    
416            /**
417             * Returns the container model ID of this journal folder.
418             *
419             * @return the container model ID of this journal folder
420             */
421            @Override
422            public long getContainerModelId();
423    
424            /**
425             * Sets the container model ID of this journal folder.
426             *
427             * @param container model ID of this journal folder
428             */
429            @Override
430            public void setContainerModelId(long containerModelId);
431    
432            /**
433             * Returns the container name of this journal folder.
434             *
435             * @return the container name of this journal folder
436             */
437            @Override
438            public String getContainerModelName();
439    
440            /**
441             * Returns the parent container model ID of this journal folder.
442             *
443             * @return the parent container model ID of this journal folder
444             */
445            @Override
446            public long getParentContainerModelId();
447    
448            /**
449             * Sets the parent container model ID of this journal folder.
450             *
451             * @param parent container model ID of this journal folder
452             */
453            @Override
454            public void setParentContainerModelId(long parentContainerModelId);
455    
456            @Override
457            public boolean isNew();
458    
459            @Override
460            public void setNew(boolean n);
461    
462            @Override
463            public boolean isCachedModel();
464    
465            @Override
466            public void setCachedModel(boolean cachedModel);
467    
468            @Override
469            public boolean isEscapedModel();
470    
471            @Override
472            public Serializable getPrimaryKeyObj();
473    
474            @Override
475            public void setPrimaryKeyObj(Serializable primaryKeyObj);
476    
477            @Override
478            public ExpandoBridge getExpandoBridge();
479    
480            @Override
481            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
482    
483            @Override
484            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
485    
486            @Override
487            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
488    
489            @Override
490            public Object clone();
491    
492            @Override
493            public int compareTo(JournalFolder journalFolder);
494    
495            @Override
496            public int hashCode();
497    
498            @Override
499            public CacheModel<JournalFolder> toCacheModel();
500    
501            @Override
502            public JournalFolder toEscapedModel();
503    
504            @Override
505            public JournalFolder toUnescapedModel();
506    
507            @Override
508            public String toString();
509    
510            @Override
511            public String toXmlString();
512    }