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.journal.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 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.
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 JournalStructureLocalService
029     * @see com.liferay.portlet.journal.service.base.JournalStructureLocalServiceBaseImpl
030     * @see com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl
031     * @generated
032     */
033    public class JournalStructureLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the journal structure to the database. Also notifies the appropriate model listeners.
042            *
043            * @param journalStructure the journal structure
044            * @return the journal structure that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.journal.model.JournalStructure addJournalStructure(
048                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addJournalStructure(journalStructure);
051            }
052    
053            /**
054            * Creates a new journal structure with the primary key. Does not add the journal structure to the database.
055            *
056            * @param id the primary key for the new journal structure
057            * @return the new journal structure
058            */
059            public static com.liferay.portlet.journal.model.JournalStructure createJournalStructure(
060                    long id) {
061                    return getService().createJournalStructure(id);
062            }
063    
064            /**
065            * Deletes the journal structure with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param id the primary key of the journal structure
068            * @return the journal structure that was removed
069            * @throws PortalException if a journal structure with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.journal.model.JournalStructure deleteJournalStructure(
073                    long id)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteJournalStructure(id);
077            }
078    
079            /**
080            * Deletes the journal structure from the database. Also notifies the appropriate model listeners.
081            *
082            * @param journalStructure the journal structure
083            * @return the journal structure that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.journal.model.JournalStructure deleteJournalStructure(
087                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteJournalStructure(journalStructure);
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.journal.model.JournalStructure fetchJournalStructure(
168                    long id) throws com.liferay.portal.kernel.exception.SystemException {
169                    return getService().fetchJournalStructure(id);
170            }
171    
172            /**
173            * Returns the journal structure with the primary key.
174            *
175            * @param id the primary key of the journal structure
176            * @return the journal structure
177            * @throws PortalException if a journal structure with the primary key could not be found
178            * @throws SystemException if a system exception occurred
179            */
180            public static com.liferay.portlet.journal.model.JournalStructure getJournalStructure(
181                    long id)
182                    throws com.liferay.portal.kernel.exception.PortalException,
183                            com.liferay.portal.kernel.exception.SystemException {
184                    return getService().getJournalStructure(id);
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 journal structure with the UUID in the group.
196            *
197            * @param uuid the UUID of journal structure
198            * @param groupId the group id of the journal structure
199            * @return the journal structure
200            * @throws PortalException if a journal structure 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.journal.model.JournalStructure getJournalStructureByUuidAndGroupId(
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().getJournalStructureByUuidAndGroupId(uuid, groupId);
208            }
209    
210            /**
211            * Returns a range of all the journal structures.
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 journal structures
218            * @param end the upper bound of the range of journal structures (not inclusive)
219            * @return the range of journal structures
220            * @throws SystemException if a system exception occurred
221            */
222            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getJournalStructures(
223                    int start, int end)
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getJournalStructures(start, end);
226            }
227    
228            /**
229            * Returns the number of journal structures.
230            *
231            * @return the number of journal structures
232            * @throws SystemException if a system exception occurred
233            */
234            public static int getJournalStructuresCount()
235                    throws com.liferay.portal.kernel.exception.SystemException {
236                    return getService().getJournalStructuresCount();
237            }
238    
239            /**
240            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
241            *
242            * @param journalStructure the journal structure
243            * @return the journal structure that was updated
244            * @throws SystemException if a system exception occurred
245            */
246            public static com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
247                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService().updateJournalStructure(journalStructure);
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.journal.model.JournalStructure addStructure(
271                    long userId, long groupId, java.lang.String structureId,
272                    boolean autoStructureId, java.lang.String parentStructureId,
273                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
274                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
275                    java.lang.String xsd,
276                    com.liferay.portal.service.ServiceContext serviceContext)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService()
280                                       .addStructure(userId, groupId, structureId, autoStructureId,
281                            parentStructureId, nameMap, descriptionMap, xsd, serviceContext);
282            }
283    
284            public static void addStructureResources(
285                    com.liferay.portlet.journal.model.JournalStructure structure,
286                    boolean addGroupPermissions, boolean addGuestPermissions)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService()
290                            .addStructureResources(structure, addGroupPermissions,
291                            addGuestPermissions);
292            }
293    
294            public static void addStructureResources(
295                    com.liferay.portlet.journal.model.JournalStructure structure,
296                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService()
300                            .addStructureResources(structure, groupPermissions, guestPermissions);
301            }
302    
303            public static void addStructureResources(long groupId,
304                    java.lang.String structureId, boolean addGroupPermissions,
305                    boolean addGuestPermissions)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    getService()
309                            .addStructureResources(groupId, structureId, addGroupPermissions,
310                            addGuestPermissions);
311            }
312    
313            public static void addStructureResources(long groupId,
314                    java.lang.String structureId, java.lang.String[] groupPermissions,
315                    java.lang.String[] guestPermissions)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    getService()
319                            .addStructureResources(groupId, structureId, groupPermissions,
320                            guestPermissions);
321            }
322    
323            public static void checkNewLine(long groupId, java.lang.String structureId)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService().checkNewLine(groupId, structureId);
327            }
328    
329            public static com.liferay.portlet.journal.model.JournalStructure copyStructure(
330                    long userId, long groupId, java.lang.String oldStructureId,
331                    java.lang.String newStructureId, boolean autoStructureId)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    return getService()
335                                       .copyStructure(userId, groupId, oldStructureId,
336                            newStructureId, autoStructureId);
337            }
338    
339            public static void deleteStructure(
340                    com.liferay.portlet.journal.model.JournalStructure structure)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException {
343                    getService().deleteStructure(structure);
344            }
345    
346            public static void deleteStructure(long groupId,
347                    java.lang.String structureId)
348                    throws com.liferay.portal.kernel.exception.PortalException,
349                            com.liferay.portal.kernel.exception.SystemException {
350                    getService().deleteStructure(groupId, structureId);
351            }
352    
353            public static void deleteStructures(long groupId)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException {
356                    getService().deleteStructures(groupId);
357            }
358    
359            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
360                    long id)
361                    throws com.liferay.portal.kernel.exception.PortalException,
362                            com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getStructure(id);
364            }
365    
366            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
367                    long groupId, java.lang.String structureId)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    return getService().getStructure(groupId, structureId);
371            }
372    
373            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
374                    long groupId, java.lang.String structureId,
375                    boolean includeGlobalStructures)
376                    throws com.liferay.portal.kernel.exception.PortalException,
377                            com.liferay.portal.kernel.exception.SystemException {
378                    return getService()
379                                       .getStructure(groupId, structureId, includeGlobalStructures);
380            }
381    
382            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures()
383                    throws com.liferay.portal.kernel.exception.SystemException {
384                    return getService().getStructures();
385            }
386    
387            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
388                    long groupId)
389                    throws com.liferay.portal.kernel.exception.SystemException {
390                    return getService().getStructures(groupId);
391            }
392    
393            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
394                    long groupId, int start, int end)
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getStructures(groupId, start, end);
397            }
398    
399            public static int getStructuresCount(long groupId)
400                    throws com.liferay.portal.kernel.exception.SystemException {
401                    return getService().getStructuresCount(groupId);
402            }
403    
404            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
405                    long companyId, long[] groupIds, java.lang.String keywords, int start,
406                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
407                    throws com.liferay.portal.kernel.exception.SystemException {
408                    return getService()
409                                       .search(companyId, groupIds, keywords, start, end, obc);
410            }
411    
412            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
413                    long companyId, long[] groupIds, java.lang.String structureId,
414                    java.lang.String name, java.lang.String description,
415                    boolean andOperator, int start, int end,
416                    com.liferay.portal.kernel.util.OrderByComparator obc)
417                    throws com.liferay.portal.kernel.exception.SystemException {
418                    return getService()
419                                       .search(companyId, groupIds, structureId, name, description,
420                            andOperator, start, end, obc);
421            }
422    
423            public static int searchCount(long companyId, long[] groupIds,
424                    java.lang.String keywords)
425                    throws com.liferay.portal.kernel.exception.SystemException {
426                    return getService().searchCount(companyId, groupIds, keywords);
427            }
428    
429            public static int searchCount(long companyId, long[] groupIds,
430                    java.lang.String structureId, java.lang.String name,
431                    java.lang.String description, boolean andOperator)
432                    throws com.liferay.portal.kernel.exception.SystemException {
433                    return getService()
434                                       .searchCount(companyId, groupIds, structureId, name,
435                            description, andOperator);
436            }
437    
438            public static com.liferay.portlet.journal.model.JournalStructure updateStructure(
439                    long groupId, java.lang.String structureId,
440                    java.lang.String parentStructureId,
441                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
442                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
443                    java.lang.String xsd,
444                    com.liferay.portal.service.ServiceContext serviceContext)
445                    throws com.liferay.portal.kernel.exception.PortalException,
446                            com.liferay.portal.kernel.exception.SystemException {
447                    return getService()
448                                       .updateStructure(groupId, structureId, parentStructureId,
449                            nameMap, descriptionMap, xsd, serviceContext);
450            }
451    
452            public static JournalStructureLocalService getService() {
453                    if (_service == null) {
454                            _service = (JournalStructureLocalService)PortalBeanLocatorUtil.locate(JournalStructureLocalService.class.getName());
455    
456                            ReferenceRegistry.registerReference(JournalStructureLocalServiceUtil.class,
457                                    "_service");
458                    }
459    
460                    return _service;
461            }
462    
463            /**
464             * @deprecated
465             */
466            public void setService(JournalStructureLocalService service) {
467            }
468    
469            private static JournalStructureLocalService _service;
470    }