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 template local service. This utility wraps {@link com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl} 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 JournalTemplateLocalService
030     * @see com.liferay.portlet.journal.service.base.JournalTemplateLocalServiceBaseImpl
031     * @see com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl
032     * @generated
033     */
034    public class JournalTemplateLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the journal template to the database. Also notifies the appropriate model listeners.
043            *
044            * @param journalTemplate the journal template
045            * @return the journal template that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.journal.model.JournalTemplate addJournalTemplate(
049                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addJournalTemplate(journalTemplate);
052            }
053    
054            /**
055            * Creates a new journal template with the primary key. Does not add the journal template to the database.
056            *
057            * @param id the primary key for the new journal template
058            * @return the new journal template
059            */
060            public static com.liferay.portlet.journal.model.JournalTemplate createJournalTemplate(
061                    long id) {
062                    return getService().createJournalTemplate(id);
063            }
064    
065            /**
066            * Deletes the journal template with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param id the primary key of the journal template
069            * @throws PortalException if a journal template with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteJournalTemplate(long id)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteJournalTemplate(id);
076            }
077    
078            /**
079            * Deletes the journal template from the database. Also notifies the appropriate model listeners.
080            *
081            * @param journalTemplate the journal template
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteJournalTemplate(
085                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteJournalTemplate(journalTemplate);
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 template with the primary key.
163            *
164            * @param id the primary key of the journal template
165            * @return the journal template
166            * @throws PortalException if a journal template 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.JournalTemplate getJournalTemplate(
170                    long id)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getJournalTemplate(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 template with the UUID in the group.
185            *
186            * @param uuid the UUID of journal template
187            * @param groupId the group id of the journal template
188            * @return the journal template
189            * @throws PortalException if a journal template 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.JournalTemplate getJournalTemplateByUuidAndGroupId(
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().getJournalTemplateByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the journal templates.
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 templates
207            * @param end the upper bound of the range of journal templates (not inclusive)
208            * @return the range of journal templates
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getJournalTemplates(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getJournalTemplates(start, end);
215            }
216    
217            /**
218            * Returns the number of journal templates.
219            *
220            * @return the number of journal templates
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getJournalTemplatesCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getJournalTemplatesCount();
226            }
227    
228            /**
229            * Updates the journal template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param journalTemplate the journal template
232            * @return the journal template that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
236                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateJournalTemplate(journalTemplate);
239            }
240    
241            /**
242            * Updates the journal template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param journalTemplate the journal template
245            * @param merge whether to merge the journal template 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 template that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
250                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateJournalTemplate(journalTemplate, 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.JournalTemplate addTemplate(
275                    long userId, long groupId, java.lang.String templateId,
276                    boolean autoTemplateId, java.lang.String structureId,
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 xsl, boolean formatXsl, java.lang.String langType,
280                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
281                    java.io.File smallImageFile,
282                    com.liferay.portal.service.ServiceContext serviceContext)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    return getService()
286                                       .addTemplate(userId, groupId, templateId, autoTemplateId,
287                            structureId, nameMap, descriptionMap, xsl, formatXsl, langType,
288                            cacheable, smallImage, smallImageURL, smallImageFile, serviceContext);
289            }
290    
291            public static void addTemplateResources(long groupId,
292                    java.lang.String templateId, boolean addGroupPermissions,
293                    boolean addGuestPermissions)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    getService()
297                            .addTemplateResources(groupId, templateId, addGroupPermissions,
298                            addGuestPermissions);
299            }
300    
301            public static void addTemplateResources(
302                    com.liferay.portlet.journal.model.JournalTemplate template,
303                    boolean addGroupPermissions, boolean addGuestPermissions)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    getService()
307                            .addTemplateResources(template, addGroupPermissions,
308                            addGuestPermissions);
309            }
310    
311            public static void addTemplateResources(long groupId,
312                    java.lang.String templateId, java.lang.String[] groupPermissions,
313                    java.lang.String[] guestPermissions)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    getService()
317                            .addTemplateResources(groupId, templateId, groupPermissions,
318                            guestPermissions);
319            }
320    
321            public static void addTemplateResources(
322                    com.liferay.portlet.journal.model.JournalTemplate template,
323                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService()
327                            .addTemplateResources(template, groupPermissions, guestPermissions);
328            }
329    
330            public static void checkNewLine(long groupId, java.lang.String templateId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    getService().checkNewLine(groupId, templateId);
334            }
335    
336            public static com.liferay.portlet.journal.model.JournalTemplate copyTemplate(
337                    long userId, long groupId, java.lang.String oldTemplateId,
338                    java.lang.String newTemplateId, boolean autoTemplateId)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException {
341                    return getService()
342                                       .copyTemplate(userId, groupId, oldTemplateId, newTemplateId,
343                            autoTemplateId);
344            }
345    
346            public static void deleteTemplate(long groupId, java.lang.String templateId)
347                    throws com.liferay.portal.kernel.exception.PortalException,
348                            com.liferay.portal.kernel.exception.SystemException {
349                    getService().deleteTemplate(groupId, templateId);
350            }
351    
352            public static void deleteTemplate(
353                    com.liferay.portlet.journal.model.JournalTemplate template)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException {
356                    getService().deleteTemplate(template);
357            }
358    
359            public static void deleteTemplates(long groupId)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException {
362                    getService().deleteTemplates(groupId);
363            }
364    
365            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
366                    long groupId, java.lang.String structureId)
367                    throws com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getStructureTemplates(groupId, structureId);
369            }
370    
371            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
372                    long groupId, java.lang.String structureId, int start, int end)
373                    throws com.liferay.portal.kernel.exception.SystemException {
374                    return getService()
375                                       .getStructureTemplates(groupId, structureId, start, end);
376            }
377    
378            public static int getStructureTemplatesCount(long groupId,
379                    java.lang.String structureId)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService().getStructureTemplatesCount(groupId, structureId);
382            }
383    
384            public static com.liferay.portlet.journal.model.JournalTemplate getTemplate(
385                    long id)
386                    throws com.liferay.portal.kernel.exception.PortalException,
387                            com.liferay.portal.kernel.exception.SystemException {
388                    return getService().getTemplate(id);
389            }
390    
391            public static com.liferay.portlet.journal.model.JournalTemplate getTemplate(
392                    long groupId, java.lang.String templateId)
393                    throws com.liferay.portal.kernel.exception.PortalException,
394                            com.liferay.portal.kernel.exception.SystemException {
395                    return getService().getTemplate(groupId, templateId);
396            }
397    
398            public static com.liferay.portlet.journal.model.JournalTemplate getTemplateBySmallImageId(
399                    long smallImageId)
400                    throws com.liferay.portal.kernel.exception.PortalException,
401                            com.liferay.portal.kernel.exception.SystemException {
402                    return getService().getTemplateBySmallImageId(smallImageId);
403            }
404    
405            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates()
406                    throws com.liferay.portal.kernel.exception.SystemException {
407                    return getService().getTemplates();
408            }
409    
410            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
411                    long groupId)
412                    throws com.liferay.portal.kernel.exception.SystemException {
413                    return getService().getTemplates(groupId);
414            }
415    
416            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
417                    long groupId, int start, int end)
418                    throws com.liferay.portal.kernel.exception.SystemException {
419                    return getService().getTemplates(groupId, start, end);
420            }
421    
422            public static int getTemplatesCount(long groupId)
423                    throws com.liferay.portal.kernel.exception.SystemException {
424                    return getService().getTemplatesCount(groupId);
425            }
426    
427            public static boolean hasTemplate(long groupId, java.lang.String templateId)
428                    throws com.liferay.portal.kernel.exception.SystemException {
429                    return getService().hasTemplate(groupId, templateId);
430            }
431    
432            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
433                    long companyId, long[] groupIds, java.lang.String keywords,
434                    java.lang.String structureId, java.lang.String structureIdComparator,
435                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
436                    throws com.liferay.portal.kernel.exception.SystemException {
437                    return getService()
438                                       .search(companyId, groupIds, keywords, structureId,
439                            structureIdComparator, start, end, obc);
440            }
441    
442            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
443                    long companyId, long[] groupIds, java.lang.String templateId,
444                    java.lang.String structureId, java.lang.String structureIdComparator,
445                    java.lang.String name, java.lang.String description,
446                    boolean andOperator, int start, int end,
447                    com.liferay.portal.kernel.util.OrderByComparator obc)
448                    throws com.liferay.portal.kernel.exception.SystemException {
449                    return getService()
450                                       .search(companyId, groupIds, templateId, structureId,
451                            structureIdComparator, name, description, andOperator, start, end,
452                            obc);
453            }
454    
455            public static int searchCount(long companyId, long[] groupIds,
456                    java.lang.String keywords, java.lang.String structureId,
457                    java.lang.String structureIdComparator)
458                    throws com.liferay.portal.kernel.exception.SystemException {
459                    return getService()
460                                       .searchCount(companyId, groupIds, keywords, structureId,
461                            structureIdComparator);
462            }
463    
464            public static int searchCount(long companyId, long[] groupIds,
465                    java.lang.String templateId, java.lang.String structureId,
466                    java.lang.String structureIdComparator, java.lang.String name,
467                    java.lang.String description, boolean andOperator)
468                    throws com.liferay.portal.kernel.exception.SystemException {
469                    return getService()
470                                       .searchCount(companyId, groupIds, templateId, structureId,
471                            structureIdComparator, name, description, andOperator);
472            }
473    
474            public static com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
475                    long groupId, java.lang.String templateId,
476                    java.lang.String structureId,
477                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
478                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
479                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
480                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
481                    java.io.File smallImageFile,
482                    com.liferay.portal.service.ServiceContext serviceContext)
483                    throws com.liferay.portal.kernel.exception.PortalException,
484                            com.liferay.portal.kernel.exception.SystemException {
485                    return getService()
486                                       .updateTemplate(groupId, templateId, structureId, nameMap,
487                            descriptionMap, xsl, formatXsl, langType, cacheable, smallImage,
488                            smallImageURL, smallImageFile, serviceContext);
489            }
490    
491            public static JournalTemplateLocalService getService() {
492                    if (_service == null) {
493                            _service = (JournalTemplateLocalService)PortalBeanLocatorUtil.locate(JournalTemplateLocalService.class.getName());
494    
495                            ReferenceRegistry.registerReference(JournalTemplateLocalServiceUtil.class,
496                                    "_service");
497                            MethodCache.remove(JournalTemplateLocalService.class);
498                    }
499    
500                    return _service;
501            }
502    
503            public void setService(JournalTemplateLocalService service) {
504                    MethodCache.remove(JournalTemplateLocalService.class);
505    
506                    _service = service;
507    
508                    ReferenceRegistry.registerReference(JournalTemplateLocalServiceUtil.class,
509                            "_service");
510                    MethodCache.remove(JournalTemplateLocalService.class);
511            }
512    
513            private static JournalTemplateLocalService _service;
514    }