001    /**
002     * Copyright (c) 2000-2010 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.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the wiki node local service. This utility wraps {@link com.liferay.portlet.wiki.service.impl.WikiNodeLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.wiki.service.impl.WikiNodeLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see WikiNodeLocalService
032     * @see com.liferay.portlet.wiki.service.base.WikiNodeLocalServiceBaseImpl
033     * @see com.liferay.portlet.wiki.service.impl.WikiNodeLocalServiceImpl
034     * @generated
035     */
036    public class WikiNodeLocalServiceUtil {
037            /**
038            * Adds the wiki node to the database. Also notifies the appropriate model listeners.
039            *
040            * @param wikiNode the wiki node to add
041            * @return the wiki node that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.wiki.model.WikiNode addWikiNode(
045                    com.liferay.portlet.wiki.model.WikiNode wikiNode)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addWikiNode(wikiNode);
048            }
049    
050            /**
051            * Creates a new wiki node with the primary key. Does not add the wiki node to the database.
052            *
053            * @param nodeId the primary key for the new wiki node
054            * @return the new wiki node
055            */
056            public static com.liferay.portlet.wiki.model.WikiNode createWikiNode(
057                    long nodeId) {
058                    return getService().createWikiNode(nodeId);
059            }
060    
061            /**
062            * Deletes the wiki node with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param nodeId the primary key of the wiki node to delete
065            * @throws PortalException if a wiki node with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteWikiNode(long nodeId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteWikiNode(nodeId);
072            }
073    
074            /**
075            * Deletes the wiki node from the database. Also notifies the appropriate model listeners.
076            *
077            * @param wikiNode the wiki node to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteWikiNode(
081                    com.liferay.portlet.wiki.model.WikiNode wikiNode)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteWikiNode(wikiNode);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the wiki node with the primary key.
159            *
160            * @param nodeId the primary key of the wiki node to get
161            * @return the wiki node
162            * @throws PortalException if a wiki node with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.wiki.model.WikiNode getWikiNode(
166                    long nodeId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getWikiNode(nodeId);
170            }
171    
172            /**
173            * Gets the wiki node with the UUID and group id.
174            *
175            * @param uuid the UUID of wiki node to get
176            * @param groupId the group id of the wiki node to get
177            * @return the wiki node
178            * @throws PortalException if a wiki node with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.wiki.model.WikiNode getWikiNodeByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getWikiNodeByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the wiki nodes.
190            *
191            * <p>
192            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
193            * </p>
194            *
195            * @param start the lower bound of the range of wiki nodes to return
196            * @param end the upper bound of the range of wiki nodes to return (not inclusive)
197            * @return the range of wiki nodes
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getWikiNodes(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getWikiNodes(start, end);
204            }
205    
206            /**
207            * Gets the number of wiki nodes.
208            *
209            * @return the number of wiki nodes
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getWikiNodesCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getWikiNodesCount();
215            }
216    
217            /**
218            * Updates the wiki node in the database. Also notifies the appropriate model listeners.
219            *
220            * @param wikiNode the wiki node to update
221            * @return the wiki node that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.wiki.model.WikiNode updateWikiNode(
225                    com.liferay.portlet.wiki.model.WikiNode wikiNode)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateWikiNode(wikiNode);
228            }
229    
230            /**
231            * Updates the wiki node in the database. Also notifies the appropriate model listeners.
232            *
233            * @param wikiNode the wiki node to update
234            * @param merge whether to merge the wiki node with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
235            * @return the wiki node that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.wiki.model.WikiNode updateWikiNode(
239                    com.liferay.portlet.wiki.model.WikiNode wikiNode, boolean merge)
240                    throws com.liferay.portal.kernel.exception.SystemException {
241                    return getService().updateWikiNode(wikiNode, merge);
242            }
243    
244            public static com.liferay.portlet.wiki.model.WikiNode addDefaultNode(
245                    long userId, com.liferay.portal.service.ServiceContext serviceContext)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException {
248                    return getService().addDefaultNode(userId, serviceContext);
249            }
250    
251            public static com.liferay.portlet.wiki.model.WikiNode addNode(long userId,
252                    java.lang.String name, java.lang.String description,
253                    com.liferay.portal.service.ServiceContext serviceContext)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException {
256                    return getService().addNode(userId, name, description, serviceContext);
257            }
258    
259            public static void addNodeResources(long nodeId,
260                    boolean addCommunityPermissions, boolean addGuestPermissions)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException {
263                    getService()
264                            .addNodeResources(nodeId, addCommunityPermissions,
265                            addGuestPermissions);
266            }
267    
268            public static void addNodeResources(
269                    com.liferay.portlet.wiki.model.WikiNode node,
270                    boolean addCommunityPermissions, boolean addGuestPermissions)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    getService()
274                            .addNodeResources(node, addCommunityPermissions, addGuestPermissions);
275            }
276    
277            public static void addNodeResources(long nodeId,
278                    java.lang.String[] communityPermissions,
279                    java.lang.String[] guestPermissions)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    getService()
283                            .addNodeResources(nodeId, communityPermissions, guestPermissions);
284            }
285    
286            public static void addNodeResources(
287                    com.liferay.portlet.wiki.model.WikiNode node,
288                    java.lang.String[] communityPermissions,
289                    java.lang.String[] guestPermissions)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService()
293                            .addNodeResources(node, communityPermissions, guestPermissions);
294            }
295    
296            public static void deleteNode(long nodeId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService().deleteNode(nodeId);
300            }
301    
302            public static void deleteNode(com.liferay.portlet.wiki.model.WikiNode node)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService().deleteNode(node);
306            }
307    
308            public static void deleteNodes(long groupId)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    getService().deleteNodes(groupId);
312            }
313    
314            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getCompanyNodes(
315                    long companyId, int start, int end)
316                    throws com.liferay.portal.kernel.exception.SystemException {
317                    return getService().getCompanyNodes(companyId, start, end);
318            }
319    
320            public static int getCompanyNodesCount(long companyId)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    return getService().getCompanyNodesCount(companyId);
323            }
324    
325            public static com.liferay.portlet.wiki.model.WikiNode getNode(long nodeId)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    return getService().getNode(nodeId);
329            }
330    
331            public static com.liferay.portlet.wiki.model.WikiNode getNode(
332                    long groupId, java.lang.String nodeName)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    return getService().getNode(groupId, nodeName);
336            }
337    
338            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getNodes(
339                    long groupId)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException {
342                    return getService().getNodes(groupId);
343            }
344    
345            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getNodes(
346                    long groupId, int start, int end)
347                    throws com.liferay.portal.kernel.exception.PortalException,
348                            com.liferay.portal.kernel.exception.SystemException {
349                    return getService().getNodes(groupId, start, end);
350            }
351    
352            public static int getNodesCount(long groupId)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService().getNodesCount(groupId);
355            }
356    
357            public static void importPages(long userId, long nodeId,
358                    java.lang.String importer, java.io.File[] files,
359                    java.util.Map<java.lang.String, java.lang.String[]> options)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException {
362                    getService().importPages(userId, nodeId, importer, files, options);
363            }
364    
365            public static void subscribeNode(long userId, long nodeId)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException {
368                    getService().subscribeNode(userId, nodeId);
369            }
370    
371            public static void unsubscribeNode(long userId, long nodeId)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException {
374                    getService().unsubscribeNode(userId, nodeId);
375            }
376    
377            public static com.liferay.portlet.wiki.model.WikiNode updateNode(
378                    long nodeId, java.lang.String name, java.lang.String description,
379                    com.liferay.portal.service.ServiceContext serviceContext)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException {
382                    return getService().updateNode(nodeId, name, description, serviceContext);
383            }
384    
385            public static WikiNodeLocalService getService() {
386                    if (_service == null) {
387                            _service = (WikiNodeLocalService)PortalBeanLocatorUtil.locate(WikiNodeLocalService.class.getName());
388                    }
389    
390                    return _service;
391            }
392    
393            public void setService(WikiNodeLocalService service) {
394                    _service = service;
395            }
396    
397            private static WikiNodeLocalService _service;
398    }