001    /**
002     * Copyright (c) 2000-2011 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    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see WikiNodeLocalService
030     * @see com.liferay.portlet.wiki.service.base.WikiNodeLocalServiceBaseImpl
031     * @see com.liferay.portlet.wiki.service.impl.WikiNodeLocalServiceImpl
032     * @generated
033     */
034    public class WikiNodeLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the wiki node to the database. Also notifies the appropriate model listeners.
043            *
044            * @param wikiNode the wiki node
045            * @return the wiki node that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.wiki.model.WikiNode addWikiNode(
049                    com.liferay.portlet.wiki.model.WikiNode wikiNode)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addWikiNode(wikiNode);
052            }
053    
054            /**
055            * Creates a new wiki node with the primary key. Does not add the wiki node to the database.
056            *
057            * @param nodeId the primary key for the new wiki node
058            * @return the new wiki node
059            */
060            public static com.liferay.portlet.wiki.model.WikiNode createWikiNode(
061                    long nodeId) {
062                    return getService().createWikiNode(nodeId);
063            }
064    
065            /**
066            * Deletes the wiki node with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param nodeId the primary key of the wiki node
069            * @throws PortalException if a wiki node with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteWikiNode(long nodeId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteWikiNode(nodeId);
076            }
077    
078            /**
079            * Deletes the wiki node from the database. Also notifies the appropriate model listeners.
080            *
081            * @param wikiNode the wiki node
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteWikiNode(
085                    com.liferay.portlet.wiki.model.WikiNode wikiNode)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteWikiNode(wikiNode);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the wiki node with the primary key.
163            *
164            * @param nodeId the primary key of the wiki node
165            * @return the wiki node
166            * @throws PortalException if a wiki node with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.wiki.model.WikiNode getWikiNode(
170                    long nodeId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getWikiNode(nodeId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns the wiki node with the UUID in the group.
185            *
186            * @param uuid the UUID of wiki node
187            * @param groupId the group id of the wiki node
188            * @return the wiki node
189            * @throws PortalException if a wiki node with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.wiki.model.WikiNode getWikiNodeByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getWikiNodeByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the wiki nodes.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of wiki nodes
207            * @param end the upper bound of the range of wiki nodes (not inclusive)
208            * @return the range of wiki nodes
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getWikiNodes(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getWikiNodes(start, end);
215            }
216    
217            /**
218            * Returns the number of wiki nodes.
219            *
220            * @return the number of wiki nodes
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getWikiNodesCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getWikiNodesCount();
226            }
227    
228            /**
229            * Updates the wiki node in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param wikiNode the wiki node
232            * @return the wiki node that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.wiki.model.WikiNode updateWikiNode(
236                    com.liferay.portlet.wiki.model.WikiNode wikiNode)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateWikiNode(wikiNode);
239            }
240    
241            /**
242            * Updates the wiki node in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param wikiNode the wiki node
245            * @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.
246            * @return the wiki node that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.wiki.model.WikiNode updateWikiNode(
250                    com.liferay.portlet.wiki.model.WikiNode wikiNode, boolean merge)
251                    throws com.liferay.portal.kernel.exception.SystemException {
252                    return getService().updateWikiNode(wikiNode, merge);
253            }
254    
255            /**
256            * Returns the Spring bean ID for this bean.
257            *
258            * @return the Spring bean ID for this bean
259            */
260            public static java.lang.String getBeanIdentifier() {
261                    return getService().getBeanIdentifier();
262            }
263    
264            /**
265            * Sets the Spring bean ID for this bean.
266            *
267            * @param beanIdentifier the Spring bean ID for this bean
268            */
269            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
270                    getService().setBeanIdentifier(beanIdentifier);
271            }
272    
273            public static com.liferay.portlet.wiki.model.WikiNode addDefaultNode(
274                    long userId, com.liferay.portal.service.ServiceContext serviceContext)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService().addDefaultNode(userId, serviceContext);
278            }
279    
280            public static com.liferay.portlet.wiki.model.WikiNode addNode(long userId,
281                    java.lang.String name, java.lang.String description,
282                    com.liferay.portal.service.ServiceContext serviceContext)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    return getService().addNode(userId, name, description, serviceContext);
286            }
287    
288            public static void addNodeResources(long nodeId,
289                    boolean addGroupPermissions, boolean addGuestPermissions)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService()
293                            .addNodeResources(nodeId, addGroupPermissions, addGuestPermissions);
294            }
295    
296            public static void addNodeResources(
297                    com.liferay.portlet.wiki.model.WikiNode node,
298                    boolean addGroupPermissions, boolean addGuestPermissions)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService()
302                            .addNodeResources(node, addGroupPermissions, addGuestPermissions);
303            }
304    
305            public static void addNodeResources(long nodeId,
306                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    getService().addNodeResources(nodeId, groupPermissions, guestPermissions);
310            }
311    
312            public static void addNodeResources(
313                    com.liferay.portlet.wiki.model.WikiNode node,
314                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    getService().addNodeResources(node, groupPermissions, guestPermissions);
318            }
319    
320            public static void deleteNode(long nodeId)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService().deleteNode(nodeId);
324            }
325    
326            public static void deleteNode(com.liferay.portlet.wiki.model.WikiNode node)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService().deleteNode(node);
330            }
331    
332            public static void deleteNodes(long groupId)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    getService().deleteNodes(groupId);
336            }
337    
338            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getCompanyNodes(
339                    long companyId, int start, int end)
340                    throws com.liferay.portal.kernel.exception.SystemException {
341                    return getService().getCompanyNodes(companyId, start, end);
342            }
343    
344            public static int getCompanyNodesCount(long companyId)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService().getCompanyNodesCount(companyId);
347            }
348    
349            public static com.liferay.portlet.wiki.model.WikiNode getNode(long nodeId)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    return getService().getNode(nodeId);
353            }
354    
355            public static com.liferay.portlet.wiki.model.WikiNode getNode(
356                    long groupId, java.lang.String nodeName)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getNode(groupId, nodeName);
360            }
361    
362            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getNodes(
363                    long groupId)
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getNodes(groupId);
367            }
368    
369            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getNodes(
370                    long groupId, int start, int end)
371                    throws com.liferay.portal.kernel.exception.PortalException,
372                            com.liferay.portal.kernel.exception.SystemException {
373                    return getService().getNodes(groupId, start, end);
374            }
375    
376            public static int getNodesCount(long groupId)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getNodesCount(groupId);
379            }
380    
381            public static void importPages(long userId, long nodeId,
382                    java.lang.String importer, java.io.InputStream[] inputStreams,
383                    java.util.Map<java.lang.String, java.lang.String[]> options)
384                    throws com.liferay.portal.kernel.exception.PortalException,
385                            com.liferay.portal.kernel.exception.SystemException {
386                    getService().importPages(userId, nodeId, importer, inputStreams, options);
387            }
388    
389            public static void subscribeNode(long userId, long nodeId)
390                    throws com.liferay.portal.kernel.exception.PortalException,
391                            com.liferay.portal.kernel.exception.SystemException {
392                    getService().subscribeNode(userId, nodeId);
393            }
394    
395            public static void unsubscribeNode(long userId, long nodeId)
396                    throws com.liferay.portal.kernel.exception.PortalException,
397                            com.liferay.portal.kernel.exception.SystemException {
398                    getService().unsubscribeNode(userId, nodeId);
399            }
400    
401            public static com.liferay.portlet.wiki.model.WikiNode updateNode(
402                    long nodeId, java.lang.String name, java.lang.String description,
403                    com.liferay.portal.service.ServiceContext serviceContext)
404                    throws com.liferay.portal.kernel.exception.PortalException,
405                            com.liferay.portal.kernel.exception.SystemException {
406                    return getService().updateNode(nodeId, name, description, serviceContext);
407            }
408    
409            public static WikiNodeLocalService getService() {
410                    if (_service == null) {
411                            _service = (WikiNodeLocalService)PortalBeanLocatorUtil.locate(WikiNodeLocalService.class.getName());
412    
413                            ReferenceRegistry.registerReference(WikiNodeLocalServiceUtil.class,
414                                    "_service");
415                            MethodCache.remove(WikiNodeLocalService.class);
416                    }
417    
418                    return _service;
419            }
420    
421            public void setService(WikiNodeLocalService service) {
422                    MethodCache.remove(WikiNodeLocalService.class);
423    
424                    _service = service;
425    
426                    ReferenceRegistry.registerReference(WikiNodeLocalServiceUtil.class,
427                            "_service");
428                    MethodCache.remove(WikiNodeLocalService.class);
429            }
430    
431            private static WikiNodeLocalService _service;
432    }