001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.journal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the 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.
023     *
024     * <p>
025     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see JournalStructureLocalService
030     * @see com.liferay.portlet.journal.service.base.JournalStructureLocalServiceBaseImpl
031     * @see com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl
032     * @generated
033     */
034    public class JournalStructureLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the journal structure to the database. Also notifies the appropriate model listeners.
043            *
044            * @param journalStructure the journal structure
045            * @return the journal structure that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.journal.model.JournalStructure addJournalStructure(
049                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addJournalStructure(journalStructure);
052            }
053    
054            /**
055            * Creates a new journal structure with the primary key. Does not add the journal structure to the database.
056            *
057            * @param id the primary key for the new journal structure
058            * @return the new journal structure
059            */
060            public static com.liferay.portlet.journal.model.JournalStructure createJournalStructure(
061                    long id) {
062                    return getService().createJournalStructure(id);
063            }
064    
065            /**
066            * Deletes the journal structure with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param id the primary key of the journal structure
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 void deleteJournalStructure(long id)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteJournalStructure(id);
076            }
077    
078            /**
079            * Deletes the journal structure from the database. Also notifies the appropriate model listeners.
080            *
081            * @param journalStructure the journal structure
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteJournalStructure(
085                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteJournalStructure(journalStructure);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the journal structure with the primary key.
163            *
164            * @param id the primary key of the journal structure
165            * @return the journal structure
166            * @throws PortalException if a journal structure with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.journal.model.JournalStructure getJournalStructure(
170                    long id)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getJournalStructure(id);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns the journal structure with the UUID in the group.
185            *
186            * @param uuid the UUID of journal structure
187            * @param groupId the group id of the journal structure
188            * @return the journal structure
189            * @throws PortalException if a journal structure with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.journal.model.JournalStructure getJournalStructureByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getJournalStructureByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the journal structures.
201            *
202            * <p>
203            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
204            * </p>
205            *
206            * @param start the lower bound of the range of journal structures
207            * @param end the upper bound of the range of journal structures (not inclusive)
208            * @return the range of journal structures
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getJournalStructures(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getJournalStructures(start, end);
215            }
216    
217            /**
218            * Returns the number of journal structures.
219            *
220            * @return the number of journal structures
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getJournalStructuresCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getJournalStructuresCount();
226            }
227    
228            /**
229            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param journalStructure the journal structure
232            * @return the journal structure that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
236                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateJournalStructure(journalStructure);
239            }
240    
241            /**
242            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param journalStructure the journal structure
245            * @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.
246            * @return the journal structure that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
250                    com.liferay.portlet.journal.model.JournalStructure journalStructure,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateJournalStructure(journalStructure, merge);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static com.liferay.portlet.journal.model.JournalStructure addStructure(
275                    long userId, long groupId, java.lang.String structureId,
276                    boolean autoStructureId, java.lang.String parentStructureId,
277                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
278                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
279                    java.lang.String xsd,
280                    com.liferay.portal.service.ServiceContext serviceContext)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    return getService()
284                                       .addStructure(userId, groupId, structureId, autoStructureId,
285                            parentStructureId, nameMap, descriptionMap, xsd, serviceContext);
286            }
287    
288            public static void addStructureResources(
289                    com.liferay.portlet.journal.model.JournalStructure structure,
290                    boolean addGroupPermissions, boolean addGuestPermissions)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException {
293                    getService()
294                            .addStructureResources(structure, addGroupPermissions,
295                            addGuestPermissions);
296            }
297    
298            public static void addStructureResources(
299                    com.liferay.portlet.journal.model.JournalStructure structure,
300                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    getService()
304                            .addStructureResources(structure, groupPermissions, guestPermissions);
305            }
306    
307            public static void addStructureResources(long groupId,
308                    java.lang.String structureId, boolean addGroupPermissions,
309                    boolean addGuestPermissions)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    getService()
313                            .addStructureResources(groupId, structureId, addGroupPermissions,
314                            addGuestPermissions);
315            }
316    
317            public static void addStructureResources(long groupId,
318                    java.lang.String structureId, java.lang.String[] groupPermissions,
319                    java.lang.String[] guestPermissions)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException {
322                    getService()
323                            .addStructureResources(groupId, structureId, groupPermissions,
324                            guestPermissions);
325            }
326    
327            public static void checkNewLine(long groupId, java.lang.String structureId)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException {
330                    getService().checkNewLine(groupId, structureId);
331            }
332    
333            public static com.liferay.portlet.journal.model.JournalStructure copyStructure(
334                    long userId, long groupId, java.lang.String oldStructureId,
335                    java.lang.String newStructureId, boolean autoStructureId)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    return getService()
339                                       .copyStructure(userId, groupId, oldStructureId,
340                            newStructureId, autoStructureId);
341            }
342    
343            public static void deleteStructure(
344                    com.liferay.portlet.journal.model.JournalStructure structure)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    getService().deleteStructure(structure);
348            }
349    
350            public static void deleteStructure(long groupId,
351                    java.lang.String structureId)
352                    throws com.liferay.portal.kernel.exception.PortalException,
353                            com.liferay.portal.kernel.exception.SystemException {
354                    getService().deleteStructure(groupId, structureId);
355            }
356    
357            public static void deleteStructures(long groupId)
358                    throws com.liferay.portal.kernel.exception.PortalException,
359                            com.liferay.portal.kernel.exception.SystemException {
360                    getService().deleteStructures(groupId);
361            }
362    
363            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
364                    long id)
365                    throws com.liferay.portal.kernel.exception.PortalException,
366                            com.liferay.portal.kernel.exception.SystemException {
367                    return getService().getStructure(id);
368            }
369    
370            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
371                    long groupId, java.lang.String structureId)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getStructure(groupId, structureId);
375            }
376    
377            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures()
378                    throws com.liferay.portal.kernel.exception.SystemException {
379                    return getService().getStructures();
380            }
381    
382            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
383                    long groupId)
384                    throws com.liferay.portal.kernel.exception.SystemException {
385                    return getService().getStructures(groupId);
386            }
387    
388            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
389                    long groupId, int start, int end)
390                    throws com.liferay.portal.kernel.exception.SystemException {
391                    return getService().getStructures(groupId, start, end);
392            }
393    
394            public static int getStructuresCount(long groupId)
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getStructuresCount(groupId);
397            }
398    
399            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
400                    long companyId, long[] groupIds, java.lang.String keywords, int start,
401                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
402                    throws com.liferay.portal.kernel.exception.SystemException {
403                    return getService()
404                                       .search(companyId, groupIds, keywords, start, end, obc);
405            }
406    
407            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
408                    long companyId, long[] groupIds, java.lang.String structureId,
409                    java.lang.String name, java.lang.String description,
410                    boolean andOperator, int start, int end,
411                    com.liferay.portal.kernel.util.OrderByComparator obc)
412                    throws com.liferay.portal.kernel.exception.SystemException {
413                    return getService()
414                                       .search(companyId, groupIds, structureId, name, description,
415                            andOperator, start, end, obc);
416            }
417    
418            public static int searchCount(long companyId, long[] groupIds,
419                    java.lang.String keywords)
420                    throws com.liferay.portal.kernel.exception.SystemException {
421                    return getService().searchCount(companyId, groupIds, keywords);
422            }
423    
424            public static int searchCount(long companyId, long[] groupIds,
425                    java.lang.String structureId, java.lang.String name,
426                    java.lang.String description, boolean andOperator)
427                    throws com.liferay.portal.kernel.exception.SystemException {
428                    return getService()
429                                       .searchCount(companyId, groupIds, structureId, name,
430                            description, andOperator);
431            }
432    
433            public static com.liferay.portlet.journal.model.JournalStructure updateStructure(
434                    long groupId, java.lang.String structureId,
435                    java.lang.String parentStructureId,
436                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
437                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
438                    java.lang.String xsd,
439                    com.liferay.portal.service.ServiceContext serviceContext)
440                    throws com.liferay.portal.kernel.exception.PortalException,
441                            com.liferay.portal.kernel.exception.SystemException {
442                    return getService()
443                                       .updateStructure(groupId, structureId, parentStructureId,
444                            nameMap, descriptionMap, xsd, serviceContext);
445            }
446    
447            public static JournalStructureLocalService getService() {
448                    if (_service == null) {
449                            _service = (JournalStructureLocalService)PortalBeanLocatorUtil.locate(JournalStructureLocalService.class.getName());
450    
451                            ReferenceRegistry.registerReference(JournalStructureLocalServiceUtil.class,
452                                    "_service");
453                            MethodCache.remove(JournalStructureLocalService.class);
454                    }
455    
456                    return _service;
457            }
458    
459            public void setService(JournalStructureLocalService service) {
460                    MethodCache.remove(JournalStructureLocalService.class);
461    
462                    _service = service;
463    
464                    ReferenceRegistry.registerReference(JournalStructureLocalServiceUtil.class,
465                            "_service");
466                    MethodCache.remove(JournalStructureLocalService.class);
467            }
468    
469            private static JournalStructureLocalService _service;
470    }