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.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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.wiki.model.impl.WikiNodeModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.wiki.model.impl.WikiNodeModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.wiki.model.impl.WikiNodeModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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            * Returns the Spring bean ID for this bean.
254            *
255            * @return the Spring bean ID for this bean
256            */
257            public static java.lang.String getBeanIdentifier() {
258                    return getService().getBeanIdentifier();
259            }
260    
261            /**
262            * Sets the Spring bean ID for this bean.
263            *
264            * @param beanIdentifier the Spring bean ID for this bean
265            */
266            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
267                    getService().setBeanIdentifier(beanIdentifier);
268            }
269    
270            public static com.liferay.portlet.wiki.model.WikiNode addDefaultNode(
271                    long userId, com.liferay.portal.service.ServiceContext serviceContext)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    return getService().addDefaultNode(userId, serviceContext);
275            }
276    
277            public static com.liferay.portlet.wiki.model.WikiNode addNode(long userId,
278                    java.lang.String name, java.lang.String description,
279                    com.liferay.portal.service.ServiceContext serviceContext)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    return getService().addNode(userId, name, description, serviceContext);
283            }
284    
285            public static void addNodeResources(long nodeId,
286                    boolean addGroupPermissions, boolean addGuestPermissions)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService()
290                            .addNodeResources(nodeId, addGroupPermissions, addGuestPermissions);
291            }
292    
293            public static void addNodeResources(long nodeId,
294                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService().addNodeResources(nodeId, groupPermissions, guestPermissions);
298            }
299    
300            public static void addNodeResources(
301                    com.liferay.portlet.wiki.model.WikiNode node,
302                    boolean addGroupPermissions, boolean addGuestPermissions)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService()
306                            .addNodeResources(node, addGroupPermissions, addGuestPermissions);
307            }
308    
309            public static void addNodeResources(
310                    com.liferay.portlet.wiki.model.WikiNode node,
311                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService().addNodeResources(node, groupPermissions, guestPermissions);
315            }
316    
317            public static void deleteNode(long nodeId)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    getService().deleteNode(nodeId);
321            }
322    
323            public static void deleteNode(com.liferay.portlet.wiki.model.WikiNode node)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService().deleteNode(node);
327            }
328    
329            public static void deleteNodes(long groupId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    getService().deleteNodes(groupId);
333            }
334    
335            public static com.liferay.portlet.wiki.model.WikiNode fetchWikiNode(
336                    long groupId, java.lang.String name)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService().fetchWikiNode(groupId, name);
339            }
340    
341            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getCompanyNodes(
342                    long companyId, int start, int end)
343                    throws com.liferay.portal.kernel.exception.SystemException {
344                    return getService().getCompanyNodes(companyId, start, end);
345            }
346    
347            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getCompanyNodes(
348                    long companyId, int status, int start, int end)
349                    throws com.liferay.portal.kernel.exception.SystemException {
350                    return getService().getCompanyNodes(companyId, status, start, end);
351            }
352    
353            public static int getCompanyNodesCount(long companyId)
354                    throws com.liferay.portal.kernel.exception.SystemException {
355                    return getService().getCompanyNodesCount(companyId);
356            }
357    
358            public static int getCompanyNodesCount(long companyId, int status)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService().getCompanyNodesCount(companyId, status);
361            }
362    
363            public static com.liferay.portlet.wiki.model.WikiNode getNode(long nodeId)
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getNode(nodeId);
367            }
368    
369            public static com.liferay.portlet.wiki.model.WikiNode getNode(
370                    long groupId, java.lang.String nodeName)
371                    throws com.liferay.portal.kernel.exception.PortalException,
372                            com.liferay.portal.kernel.exception.SystemException {
373                    return getService().getNode(groupId, nodeName);
374            }
375    
376            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getNodes(
377                    long groupId)
378                    throws com.liferay.portal.kernel.exception.PortalException,
379                            com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getNodes(groupId);
381            }
382    
383            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getNodes(
384                    long groupId, int status)
385                    throws com.liferay.portal.kernel.exception.PortalException,
386                            com.liferay.portal.kernel.exception.SystemException {
387                    return getService().getNodes(groupId, status);
388            }
389    
390            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getNodes(
391                    long groupId, int start, int end)
392                    throws com.liferay.portal.kernel.exception.PortalException,
393                            com.liferay.portal.kernel.exception.SystemException {
394                    return getService().getNodes(groupId, start, end);
395            }
396    
397            public static java.util.List<com.liferay.portlet.wiki.model.WikiNode> getNodes(
398                    long groupId, int status, int start, int end)
399                    throws com.liferay.portal.kernel.exception.PortalException,
400                            com.liferay.portal.kernel.exception.SystemException {
401                    return getService().getNodes(groupId, status, start, end);
402            }
403    
404            public static int getNodesCount(long groupId)
405                    throws com.liferay.portal.kernel.exception.SystemException {
406                    return getService().getNodesCount(groupId);
407            }
408    
409            public static int getNodesCount(long groupId, int status)
410                    throws com.liferay.portal.kernel.exception.SystemException {
411                    return getService().getNodesCount(groupId, status);
412            }
413    
414            public static void importPages(long userId, long nodeId,
415                    java.lang.String importer, java.io.InputStream[] inputStreams,
416                    java.util.Map<java.lang.String, java.lang.String[]> options)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException {
419                    getService().importPages(userId, nodeId, importer, inputStreams, options);
420            }
421    
422            public static com.liferay.portlet.wiki.model.WikiNode moveNodeToTrash(
423                    long userId, long nodeId)
424                    throws com.liferay.portal.kernel.exception.PortalException,
425                            com.liferay.portal.kernel.exception.SystemException {
426                    return getService().moveNodeToTrash(userId, nodeId);
427            }
428    
429            public static com.liferay.portlet.wiki.model.WikiNode moveNodeToTrash(
430                    long userId, com.liferay.portlet.wiki.model.WikiNode node)
431                    throws com.liferay.portal.kernel.exception.PortalException,
432                            com.liferay.portal.kernel.exception.SystemException {
433                    return getService().moveNodeToTrash(userId, node);
434            }
435    
436            public static void restoreNodeFromTrash(long userId,
437                    com.liferay.portlet.wiki.model.WikiNode node)
438                    throws com.liferay.portal.kernel.exception.PortalException,
439                            com.liferay.portal.kernel.exception.SystemException {
440                    getService().restoreNodeFromTrash(userId, node);
441            }
442    
443            public static void subscribeNode(long userId, long nodeId)
444                    throws com.liferay.portal.kernel.exception.PortalException,
445                            com.liferay.portal.kernel.exception.SystemException {
446                    getService().subscribeNode(userId, nodeId);
447            }
448    
449            public static void unsubscribeNode(long userId, long nodeId)
450                    throws com.liferay.portal.kernel.exception.PortalException,
451                            com.liferay.portal.kernel.exception.SystemException {
452                    getService().unsubscribeNode(userId, nodeId);
453            }
454    
455            public static com.liferay.portlet.wiki.model.WikiNode updateNode(
456                    long nodeId, java.lang.String name, java.lang.String description,
457                    com.liferay.portal.service.ServiceContext serviceContext)
458                    throws com.liferay.portal.kernel.exception.PortalException,
459                            com.liferay.portal.kernel.exception.SystemException {
460                    return getService().updateNode(nodeId, name, description, serviceContext);
461            }
462    
463            public static com.liferay.portlet.wiki.model.WikiNode updateStatus(
464                    long userId, com.liferay.portlet.wiki.model.WikiNode node, int status,
465                    com.liferay.portal.service.ServiceContext serviceContext)
466                    throws com.liferay.portal.kernel.exception.PortalException,
467                            com.liferay.portal.kernel.exception.SystemException {
468                    return getService().updateStatus(userId, node, status, serviceContext);
469            }
470    
471            public static WikiNodeLocalService getService() {
472                    if (_service == null) {
473                            _service = (WikiNodeLocalService)PortalBeanLocatorUtil.locate(WikiNodeLocalService.class.getName());
474    
475                            ReferenceRegistry.registerReference(WikiNodeLocalServiceUtil.class,
476                                    "_service");
477                    }
478    
479                    return _service;
480            }
481    
482            /**
483             * @deprecated
484             */
485            public void setService(WikiNodeLocalService service) {
486            }
487    
488            private static WikiNodeLocalService _service;
489    }