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