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