001    /**
002     * Copyright (c) 2000-2012 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.wiki.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.GroupedModel;
022    import com.liferay.portal.model.WorkflowedModel;
023    import com.liferay.portal.service.ServiceContext;
024    
025    import com.liferay.portlet.expando.model.ExpandoBridge;
026    
027    import java.io.Serializable;
028    
029    import java.util.Date;
030    
031    /**
032     * The base model interface for the WikiNode service. Represents a row in the "WikiNode" database table, with each column mapped to a property of this class.
033     *
034     * <p>
035     * This interface and its corresponding implementation {@link com.liferay.portlet.wiki.model.impl.WikiNodeModelImpl} 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.wiki.model.impl.WikiNodeImpl}.
036     * </p>
037     *
038     * @author Brian Wing Shun Chan
039     * @see WikiNode
040     * @see com.liferay.portlet.wiki.model.impl.WikiNodeImpl
041     * @see com.liferay.portlet.wiki.model.impl.WikiNodeModelImpl
042     * @generated
043     */
044    public interface WikiNodeModel extends BaseModel<WikiNode>, GroupedModel,
045            WorkflowedModel {
046            /*
047             * NOTE FOR DEVELOPERS:
048             *
049             * Never modify or reference this interface directly. All methods that expect a wiki node model instance should use the {@link WikiNode} interface instead.
050             */
051    
052            /**
053             * Returns the primary key of this wiki node.
054             *
055             * @return the primary key of this wiki node
056             */
057            public long getPrimaryKey();
058    
059            /**
060             * Sets the primary key of this wiki node.
061             *
062             * @param primaryKey the primary key of this wiki node
063             */
064            public void setPrimaryKey(long primaryKey);
065    
066            /**
067             * Returns the uuid of this wiki node.
068             *
069             * @return the uuid of this wiki node
070             */
071            @AutoEscape
072            public String getUuid();
073    
074            /**
075             * Sets the uuid of this wiki node.
076             *
077             * @param uuid the uuid of this wiki node
078             */
079            public void setUuid(String uuid);
080    
081            /**
082             * Returns the node ID of this wiki node.
083             *
084             * @return the node ID of this wiki node
085             */
086            public long getNodeId();
087    
088            /**
089             * Sets the node ID of this wiki node.
090             *
091             * @param nodeId the node ID of this wiki node
092             */
093            public void setNodeId(long nodeId);
094    
095            /**
096             * Returns the group ID of this wiki node.
097             *
098             * @return the group ID of this wiki node
099             */
100            public long getGroupId();
101    
102            /**
103             * Sets the group ID of this wiki node.
104             *
105             * @param groupId the group ID of this wiki node
106             */
107            public void setGroupId(long groupId);
108    
109            /**
110             * Returns the company ID of this wiki node.
111             *
112             * @return the company ID of this wiki node
113             */
114            public long getCompanyId();
115    
116            /**
117             * Sets the company ID of this wiki node.
118             *
119             * @param companyId the company ID of this wiki node
120             */
121            public void setCompanyId(long companyId);
122    
123            /**
124             * Returns the user ID of this wiki node.
125             *
126             * @return the user ID of this wiki node
127             */
128            public long getUserId();
129    
130            /**
131             * Sets the user ID of this wiki node.
132             *
133             * @param userId the user ID of this wiki node
134             */
135            public void setUserId(long userId);
136    
137            /**
138             * Returns the user uuid of this wiki node.
139             *
140             * @return the user uuid of this wiki node
141             * @throws SystemException if a system exception occurred
142             */
143            public String getUserUuid() throws SystemException;
144    
145            /**
146             * Sets the user uuid of this wiki node.
147             *
148             * @param userUuid the user uuid of this wiki node
149             */
150            public void setUserUuid(String userUuid);
151    
152            /**
153             * Returns the user name of this wiki node.
154             *
155             * @return the user name of this wiki node
156             */
157            @AutoEscape
158            public String getUserName();
159    
160            /**
161             * Sets the user name of this wiki node.
162             *
163             * @param userName the user name of this wiki node
164             */
165            public void setUserName(String userName);
166    
167            /**
168             * Returns the create date of this wiki node.
169             *
170             * @return the create date of this wiki node
171             */
172            public Date getCreateDate();
173    
174            /**
175             * Sets the create date of this wiki node.
176             *
177             * @param createDate the create date of this wiki node
178             */
179            public void setCreateDate(Date createDate);
180    
181            /**
182             * Returns the modified date of this wiki node.
183             *
184             * @return the modified date of this wiki node
185             */
186            public Date getModifiedDate();
187    
188            /**
189             * Sets the modified date of this wiki node.
190             *
191             * @param modifiedDate the modified date of this wiki node
192             */
193            public void setModifiedDate(Date modifiedDate);
194    
195            /**
196             * Returns the name of this wiki node.
197             *
198             * @return the name of this wiki node
199             */
200            @AutoEscape
201            public String getName();
202    
203            /**
204             * Sets the name of this wiki node.
205             *
206             * @param name the name of this wiki node
207             */
208            public void setName(String name);
209    
210            /**
211             * Returns the description of this wiki node.
212             *
213             * @return the description of this wiki node
214             */
215            @AutoEscape
216            public String getDescription();
217    
218            /**
219             * Sets the description of this wiki node.
220             *
221             * @param description the description of this wiki node
222             */
223            public void setDescription(String description);
224    
225            /**
226             * Returns the last post date of this wiki node.
227             *
228             * @return the last post date of this wiki node
229             */
230            public Date getLastPostDate();
231    
232            /**
233             * Sets the last post date of this wiki node.
234             *
235             * @param lastPostDate the last post date of this wiki node
236             */
237            public void setLastPostDate(Date lastPostDate);
238    
239            /**
240             * Returns the status of this wiki node.
241             *
242             * @return the status of this wiki node
243             */
244            public int getStatus();
245    
246            /**
247             * Sets the status of this wiki node.
248             *
249             * @param status the status of this wiki node
250             */
251            public void setStatus(int status);
252    
253            /**
254             * Returns the status by user ID of this wiki node.
255             *
256             * @return the status by user ID of this wiki node
257             */
258            public long getStatusByUserId();
259    
260            /**
261             * Sets the status by user ID of this wiki node.
262             *
263             * @param statusByUserId the status by user ID of this wiki node
264             */
265            public void setStatusByUserId(long statusByUserId);
266    
267            /**
268             * Returns the status by user uuid of this wiki node.
269             *
270             * @return the status by user uuid of this wiki node
271             * @throws SystemException if a system exception occurred
272             */
273            public String getStatusByUserUuid() throws SystemException;
274    
275            /**
276             * Sets the status by user uuid of this wiki node.
277             *
278             * @param statusByUserUuid the status by user uuid of this wiki node
279             */
280            public void setStatusByUserUuid(String statusByUserUuid);
281    
282            /**
283             * Returns the status by user name of this wiki node.
284             *
285             * @return the status by user name of this wiki node
286             */
287            @AutoEscape
288            public String getStatusByUserName();
289    
290            /**
291             * Sets the status by user name of this wiki node.
292             *
293             * @param statusByUserName the status by user name of this wiki node
294             */
295            public void setStatusByUserName(String statusByUserName);
296    
297            /**
298             * Returns the status date of this wiki node.
299             *
300             * @return the status date of this wiki node
301             */
302            public Date getStatusDate();
303    
304            /**
305             * Sets the status date of this wiki node.
306             *
307             * @param statusDate the status date of this wiki node
308             */
309            public void setStatusDate(Date statusDate);
310    
311            /**
312             * @deprecated Renamed to {@link #isApproved()}
313             */
314            public boolean getApproved();
315    
316            /**
317             * Returns <code>true</code> if this wiki node is approved.
318             *
319             * @return <code>true</code> if this wiki node is approved; <code>false</code> otherwise
320             */
321            public boolean isApproved();
322    
323            /**
324             * Returns <code>true</code> if this wiki node is denied.
325             *
326             * @return <code>true</code> if this wiki node is denied; <code>false</code> otherwise
327             */
328            public boolean isDenied();
329    
330            /**
331             * Returns <code>true</code> if this wiki node is a draft.
332             *
333             * @return <code>true</code> if this wiki node is a draft; <code>false</code> otherwise
334             */
335            public boolean isDraft();
336    
337            /**
338             * Returns <code>true</code> if this wiki node is expired.
339             *
340             * @return <code>true</code> if this wiki node is expired; <code>false</code> otherwise
341             */
342            public boolean isExpired();
343    
344            /**
345             * Returns <code>true</code> if this wiki node is inactive.
346             *
347             * @return <code>true</code> if this wiki node is inactive; <code>false</code> otherwise
348             */
349            public boolean isInactive();
350    
351            /**
352             * Returns <code>true</code> if this wiki node is incomplete.
353             *
354             * @return <code>true</code> if this wiki node is incomplete; <code>false</code> otherwise
355             */
356            public boolean isIncomplete();
357    
358            /**
359             * Returns <code>true</code> if this wiki node is in the Recycle Bin.
360             *
361             * @return <code>true</code> if this wiki node is in the Recycle Bin; <code>false</code> otherwise
362             */
363            public boolean isInTrash();
364    
365            /**
366             * Returns <code>true</code> if this wiki node is pending.
367             *
368             * @return <code>true</code> if this wiki node is pending; <code>false</code> otherwise
369             */
370            public boolean isPending();
371    
372            /**
373             * Returns <code>true</code> if this wiki node is scheduled.
374             *
375             * @return <code>true</code> if this wiki node is scheduled; <code>false</code> otherwise
376             */
377            public boolean isScheduled();
378    
379            public boolean isNew();
380    
381            public void setNew(boolean n);
382    
383            public boolean isCachedModel();
384    
385            public void setCachedModel(boolean cachedModel);
386    
387            public boolean isEscapedModel();
388    
389            public Serializable getPrimaryKeyObj();
390    
391            public void setPrimaryKeyObj(Serializable primaryKeyObj);
392    
393            public ExpandoBridge getExpandoBridge();
394    
395            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
396    
397            public Object clone();
398    
399            public int compareTo(WikiNode wikiNode);
400    
401            public int hashCode();
402    
403            public CacheModel<WikiNode> toCacheModel();
404    
405            public WikiNode toEscapedModel();
406    
407            public String toString();
408    
409            public String toXmlString();
410    }