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.journal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the journal structure local service. This utility wraps {@link com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl} 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.journal.service.impl.JournalStructureLocalServiceImpl} 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 JournalStructureLocalService
032     * @see com.liferay.portlet.journal.service.base.JournalStructureLocalServiceBaseImpl
033     * @see com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl
034     * @generated
035     */
036    public class JournalStructureLocalServiceUtil {
037            /**
038            * Adds the journal structure to the database. Also notifies the appropriate model listeners.
039            *
040            * @param journalStructure the journal structure to add
041            * @return the journal structure that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.journal.model.JournalStructure addJournalStructure(
045                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addJournalStructure(journalStructure);
048            }
049    
050            /**
051            * Creates a new journal structure with the primary key. Does not add the journal structure to the database.
052            *
053            * @param id the primary key for the new journal structure
054            * @return the new journal structure
055            */
056            public static com.liferay.portlet.journal.model.JournalStructure createJournalStructure(
057                    long id) {
058                    return getService().createJournalStructure(id);
059            }
060    
061            /**
062            * Deletes the journal structure with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param id the primary key of the journal structure to delete
065            * @throws PortalException if a journal structure with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteJournalStructure(long id)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteJournalStructure(id);
072            }
073    
074            /**
075            * Deletes the journal structure from the database. Also notifies the appropriate model listeners.
076            *
077            * @param journalStructure the journal structure to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteJournalStructure(
081                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteJournalStructure(journalStructure);
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 journal structure with the primary key.
159            *
160            * @param id the primary key of the journal structure to get
161            * @return the journal structure
162            * @throws PortalException if a journal structure with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.journal.model.JournalStructure getJournalStructure(
166                    long id)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getJournalStructure(id);
170            }
171    
172            /**
173            * Gets the journal structure with the UUID and group id.
174            *
175            * @param uuid the UUID of journal structure to get
176            * @param groupId the group id of the journal structure to get
177            * @return the journal structure
178            * @throws PortalException if a journal structure 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.journal.model.JournalStructure getJournalStructureByUuidAndGroupId(
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().getJournalStructureByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the journal structures.
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 journal structures to return
196            * @param end the upper bound of the range of journal structures to return (not inclusive)
197            * @return the range of journal structures
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getJournalStructures(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getJournalStructures(start, end);
204            }
205    
206            /**
207            * Gets the number of journal structures.
208            *
209            * @return the number of journal structures
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getJournalStructuresCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getJournalStructuresCount();
215            }
216    
217            /**
218            * Updates the journal structure in the database. Also notifies the appropriate model listeners.
219            *
220            * @param journalStructure the journal structure to update
221            * @return the journal structure that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
225                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateJournalStructure(journalStructure);
228            }
229    
230            /**
231            * Updates the journal structure in the database. Also notifies the appropriate model listeners.
232            *
233            * @param journalStructure the journal structure to update
234            * @param merge whether to merge the journal structure 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 journal structure that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
239                    com.liferay.portlet.journal.model.JournalStructure journalStructure,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateJournalStructure(journalStructure, merge);
243            }
244    
245            public static com.liferay.portlet.journal.model.JournalStructure addStructure(
246                    long userId, long groupId, java.lang.String structureId,
247                    boolean autoStructureId, java.lang.String parentStructureId,
248                    java.lang.String name, java.lang.String description,
249                    java.lang.String xsd,
250                    com.liferay.portal.service.ServiceContext serviceContext)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException {
253                    return getService()
254                                       .addStructure(userId, groupId, structureId, autoStructureId,
255                            parentStructureId, name, description, xsd, serviceContext);
256            }
257    
258            public static void addStructureResources(long groupId,
259                    java.lang.String structureId, boolean addCommunityPermissions,
260                    boolean addGuestPermissions)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException {
263                    getService()
264                            .addStructureResources(groupId, structureId,
265                            addCommunityPermissions, addGuestPermissions);
266            }
267    
268            public static void addStructureResources(
269                    com.liferay.portlet.journal.model.JournalStructure structure,
270                    boolean addCommunityPermissions, boolean addGuestPermissions)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    getService()
274                            .addStructureResources(structure, addCommunityPermissions,
275                            addGuestPermissions);
276            }
277    
278            public static void addStructureResources(long groupId,
279                    java.lang.String structureId, java.lang.String[] communityPermissions,
280                    java.lang.String[] guestPermissions)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    getService()
284                            .addStructureResources(groupId, structureId, communityPermissions,
285                            guestPermissions);
286            }
287    
288            public static void addStructureResources(
289                    com.liferay.portlet.journal.model.JournalStructure structure,
290                    java.lang.String[] communityPermissions,
291                    java.lang.String[] guestPermissions)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    getService()
295                            .addStructureResources(structure, communityPermissions,
296                            guestPermissions);
297            }
298    
299            public static void checkNewLine(long groupId, java.lang.String structureId)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    getService().checkNewLine(groupId, structureId);
303            }
304    
305            public static com.liferay.portlet.journal.model.JournalStructure copyStructure(
306                    long userId, long groupId, java.lang.String oldStructureId,
307                    java.lang.String newStructureId, boolean autoStructureId)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    return getService()
311                                       .copyStructure(userId, groupId, oldStructureId,
312                            newStructureId, autoStructureId);
313            }
314    
315            public static void deleteStructure(long groupId,
316                    java.lang.String structureId)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    getService().deleteStructure(groupId, structureId);
320            }
321    
322            public static void deleteStructure(
323                    com.liferay.portlet.journal.model.JournalStructure structure)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService().deleteStructure(structure);
327            }
328    
329            public static void deleteStructures(long groupId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    getService().deleteStructures(groupId);
333            }
334    
335            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
336                    long id)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getStructure(id);
340            }
341    
342            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
343                    long groupId, java.lang.String structureId)
344                    throws com.liferay.portal.kernel.exception.PortalException,
345                            com.liferay.portal.kernel.exception.SystemException {
346                    return getService().getStructure(groupId, structureId);
347            }
348    
349            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures()
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().getStructures();
352            }
353    
354            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
355                    long groupId)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService().getStructures(groupId);
358            }
359    
360            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
361                    long groupId, int start, int end)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getStructures(groupId, start, end);
364            }
365    
366            public static int getStructuresCount(long groupId)
367                    throws com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getStructuresCount(groupId);
369            }
370    
371            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
372                    long companyId, long groupId, java.lang.String keywords, int start,
373                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService().search(companyId, groupId, keywords, start, end, obc);
376            }
377    
378            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
379                    long companyId, long groupId, java.lang.String structureId,
380                    java.lang.String name, java.lang.String description,
381                    boolean andOperator, int start, int end,
382                    com.liferay.portal.kernel.util.OrderByComparator obc)
383                    throws com.liferay.portal.kernel.exception.SystemException {
384                    return getService()
385                                       .search(companyId, groupId, structureId, name, description,
386                            andOperator, start, end, obc);
387            }
388    
389            public static int searchCount(long companyId, long groupId,
390                    java.lang.String keywords)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService().searchCount(companyId, groupId, keywords);
393            }
394    
395            public static int searchCount(long companyId, long groupId,
396                    java.lang.String structureId, java.lang.String name,
397                    java.lang.String description, boolean andOperator)
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService()
400                                       .searchCount(companyId, groupId, structureId, name,
401                            description, andOperator);
402            }
403    
404            public static com.liferay.portlet.journal.model.JournalStructure updateStructure(
405                    long groupId, java.lang.String structureId,
406                    java.lang.String parentStructureId, java.lang.String name,
407                    java.lang.String description, java.lang.String xsd,
408                    com.liferay.portal.service.ServiceContext serviceContext)
409                    throws com.liferay.portal.kernel.exception.PortalException,
410                            com.liferay.portal.kernel.exception.SystemException {
411                    return getService()
412                                       .updateStructure(groupId, structureId, parentStructureId,
413                            name, description, xsd, serviceContext);
414            }
415    
416            public static JournalStructureLocalService getService() {
417                    if (_service == null) {
418                            _service = (JournalStructureLocalService)PortalBeanLocatorUtil.locate(JournalStructureLocalService.class.getName());
419                    }
420    
421                    return _service;
422            }
423    
424            public void setService(JournalStructureLocalService service) {
425                    _service = service;
426            }
427    
428            private static JournalStructureLocalService _service;
429    }