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