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 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalTemplateModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalTemplateModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalTemplateModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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            * 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.JournalTemplate addTemplate(
271                    long userId, long groupId, java.lang.String templateId,
272                    boolean autoTemplateId, java.lang.String structureId,
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 xsl, boolean formatXsl, java.lang.String langType,
276                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
277                    java.io.File smallImageFile,
278                    com.liferay.portal.service.ServiceContext serviceContext)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    return getService()
282                                       .addTemplate(userId, groupId, templateId, autoTemplateId,
283                            structureId, nameMap, descriptionMap, xsl, formatXsl, langType,
284                            cacheable, smallImage, smallImageURL, smallImageFile, serviceContext);
285            }
286    
287            public static void addTemplateResources(
288                    com.liferay.portlet.journal.model.JournalTemplate template,
289                    boolean addGroupPermissions, boolean addGuestPermissions)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService()
293                            .addTemplateResources(template, addGroupPermissions,
294                            addGuestPermissions);
295            }
296    
297            public static void addTemplateResources(
298                    com.liferay.portlet.journal.model.JournalTemplate template,
299                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    getService()
303                            .addTemplateResources(template, groupPermissions, guestPermissions);
304            }
305    
306            public static void addTemplateResources(long groupId,
307                    java.lang.String templateId, boolean addGroupPermissions,
308                    boolean addGuestPermissions)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    getService()
312                            .addTemplateResources(groupId, templateId, addGroupPermissions,
313                            addGuestPermissions);
314            }
315    
316            public static void addTemplateResources(long groupId,
317                    java.lang.String templateId, java.lang.String[] groupPermissions,
318                    java.lang.String[] guestPermissions)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    getService()
322                            .addTemplateResources(groupId, templateId, groupPermissions,
323                            guestPermissions);
324            }
325    
326            public static void checkNewLine(long groupId, java.lang.String templateId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService().checkNewLine(groupId, templateId);
330            }
331    
332            public static com.liferay.portlet.journal.model.JournalTemplate copyTemplate(
333                    long userId, long groupId, java.lang.String oldTemplateId,
334                    java.lang.String newTemplateId, boolean autoTemplateId)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException {
337                    return getService()
338                                       .copyTemplate(userId, groupId, oldTemplateId, newTemplateId,
339                            autoTemplateId);
340            }
341    
342            public static void deleteTemplate(
343                    com.liferay.portlet.journal.model.JournalTemplate template)
344                    throws com.liferay.portal.kernel.exception.PortalException,
345                            com.liferay.portal.kernel.exception.SystemException {
346                    getService().deleteTemplate(template);
347            }
348    
349            public static void deleteTemplate(long groupId, java.lang.String templateId)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    getService().deleteTemplate(groupId, templateId);
353            }
354    
355            public static void deleteTemplates(long groupId)
356                    throws com.liferay.portal.kernel.exception.PortalException,
357                            com.liferay.portal.kernel.exception.SystemException {
358                    getService().deleteTemplates(groupId);
359            }
360    
361            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
362                    long groupId, java.lang.String structureId)
363                    throws com.liferay.portal.kernel.exception.SystemException {
364                    return getService().getStructureTemplates(groupId, structureId);
365            }
366    
367            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
368                    long groupId, java.lang.String structureId, int start, int end)
369                    throws com.liferay.portal.kernel.exception.SystemException {
370                    return getService()
371                                       .getStructureTemplates(groupId, structureId, start, end);
372            }
373    
374            public static int getStructureTemplatesCount(long groupId,
375                    java.lang.String structureId)
376                    throws com.liferay.portal.kernel.exception.SystemException {
377                    return getService().getStructureTemplatesCount(groupId, structureId);
378            }
379    
380            public static com.liferay.portlet.journal.model.JournalTemplate getTemplate(
381                    long id)
382                    throws com.liferay.portal.kernel.exception.PortalException,
383                            com.liferay.portal.kernel.exception.SystemException {
384                    return getService().getTemplate(id);
385            }
386    
387            public static com.liferay.portlet.journal.model.JournalTemplate getTemplate(
388                    long groupId, java.lang.String templateId)
389                    throws com.liferay.portal.kernel.exception.PortalException,
390                            com.liferay.portal.kernel.exception.SystemException {
391                    return getService().getTemplate(groupId, templateId);
392            }
393    
394            public static com.liferay.portlet.journal.model.JournalTemplate getTemplate(
395                    long groupId, java.lang.String templateId,
396                    boolean includeGlobalTemplates)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException {
399                    return getService()
400                                       .getTemplate(groupId, templateId, includeGlobalTemplates);
401            }
402    
403            public static com.liferay.portlet.journal.model.JournalTemplate getTemplateBySmallImageId(
404                    long smallImageId)
405                    throws com.liferay.portal.kernel.exception.PortalException,
406                            com.liferay.portal.kernel.exception.SystemException {
407                    return getService().getTemplateBySmallImageId(smallImageId);
408            }
409    
410            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates()
411                    throws com.liferay.portal.kernel.exception.SystemException {
412                    return getService().getTemplates();
413            }
414    
415            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
416                    long groupId)
417                    throws com.liferay.portal.kernel.exception.SystemException {
418                    return getService().getTemplates(groupId);
419            }
420    
421            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
422                    long groupId, int start, int end)
423                    throws com.liferay.portal.kernel.exception.SystemException {
424                    return getService().getTemplates(groupId, start, end);
425            }
426    
427            public static int getTemplatesCount(long groupId)
428                    throws com.liferay.portal.kernel.exception.SystemException {
429                    return getService().getTemplatesCount(groupId);
430            }
431    
432            public static boolean hasTemplate(long groupId, java.lang.String templateId)
433                    throws com.liferay.portal.kernel.exception.SystemException {
434                    return getService().hasTemplate(groupId, templateId);
435            }
436    
437            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
438                    long companyId, long[] groupIds, java.lang.String keywords,
439                    java.lang.String structureId, java.lang.String structureIdComparator,
440                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
441                    throws com.liferay.portal.kernel.exception.SystemException {
442                    return getService()
443                                       .search(companyId, groupIds, keywords, structureId,
444                            structureIdComparator, start, end, obc);
445            }
446    
447            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
448                    long companyId, long[] groupIds, java.lang.String templateId,
449                    java.lang.String structureId, java.lang.String structureIdComparator,
450                    java.lang.String name, java.lang.String description,
451                    boolean andOperator, int start, int end,
452                    com.liferay.portal.kernel.util.OrderByComparator obc)
453                    throws com.liferay.portal.kernel.exception.SystemException {
454                    return getService()
455                                       .search(companyId, groupIds, templateId, structureId,
456                            structureIdComparator, name, description, andOperator, start, end,
457                            obc);
458            }
459    
460            public static int searchCount(long companyId, long[] groupIds,
461                    java.lang.String keywords, java.lang.String structureId,
462                    java.lang.String structureIdComparator)
463                    throws com.liferay.portal.kernel.exception.SystemException {
464                    return getService()
465                                       .searchCount(companyId, groupIds, keywords, structureId,
466                            structureIdComparator);
467            }
468    
469            public static int searchCount(long companyId, long[] groupIds,
470                    java.lang.String templateId, java.lang.String structureId,
471                    java.lang.String structureIdComparator, java.lang.String name,
472                    java.lang.String description, boolean andOperator)
473                    throws com.liferay.portal.kernel.exception.SystemException {
474                    return getService()
475                                       .searchCount(companyId, groupIds, templateId, structureId,
476                            structureIdComparator, name, description, andOperator);
477            }
478    
479            public static com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
480                    long groupId, java.lang.String templateId,
481                    java.lang.String structureId,
482                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
483                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
484                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
485                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
486                    java.io.File smallImageFile,
487                    com.liferay.portal.service.ServiceContext serviceContext)
488                    throws com.liferay.portal.kernel.exception.PortalException,
489                            com.liferay.portal.kernel.exception.SystemException {
490                    return getService()
491                                       .updateTemplate(groupId, templateId, structureId, nameMap,
492                            descriptionMap, xsl, formatXsl, langType, cacheable, smallImage,
493                            smallImageURL, smallImageFile, serviceContext);
494            }
495    
496            public static JournalTemplateLocalService getService() {
497                    if (_service == null) {
498                            _service = (JournalTemplateLocalService)PortalBeanLocatorUtil.locate(JournalTemplateLocalService.class.getName());
499    
500                            ReferenceRegistry.registerReference(JournalTemplateLocalServiceUtil.class,
501                                    "_service");
502                    }
503    
504                    return _service;
505            }
506    
507            /**
508             * @deprecated
509             */
510            public void setService(JournalTemplateLocalService service) {
511            }
512    
513            private static JournalTemplateLocalService _service;
514    }