001    /**
002     * Copyright (c) 2000-2010 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    
019    /**
020     * 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.
021     *
022     * <p>
023     * 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.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see JournalTemplateLocalService
032     * @see com.liferay.portlet.journal.service.base.JournalTemplateLocalServiceBaseImpl
033     * @see com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl
034     * @generated
035     */
036    public class JournalTemplateLocalServiceUtil {
037            /**
038            * Adds the journal template to the database. Also notifies the appropriate model listeners.
039            *
040            * @param journalTemplate the journal template to add
041            * @return the journal template that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.journal.model.JournalTemplate addJournalTemplate(
045                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addJournalTemplate(journalTemplate);
048            }
049    
050            /**
051            * Creates a new journal template with the primary key. Does not add the journal template to the database.
052            *
053            * @param id the primary key for the new journal template
054            * @return the new journal template
055            */
056            public static com.liferay.portlet.journal.model.JournalTemplate createJournalTemplate(
057                    long id) {
058                    return getService().createJournalTemplate(id);
059            }
060    
061            /**
062            * Deletes the journal template with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param id the primary key of the journal template to delete
065            * @throws PortalException if a journal template with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteJournalTemplate(long id)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteJournalTemplate(id);
072            }
073    
074            /**
075            * Deletes the journal template from the database. Also notifies the appropriate model listeners.
076            *
077            * @param journalTemplate the journal template to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteJournalTemplate(
081                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteJournalTemplate(journalTemplate);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the journal template with the primary key.
159            *
160            * @param id the primary key of the journal template to get
161            * @return the journal template
162            * @throws PortalException if a journal template with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.journal.model.JournalTemplate getJournalTemplate(
166                    long id)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getJournalTemplate(id);
170            }
171    
172            /**
173            * Gets the journal template with the UUID and group id.
174            *
175            * @param uuid the UUID of journal template to get
176            * @param groupId the group id of the journal template to get
177            * @return the journal template
178            * @throws PortalException if a journal template with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.journal.model.JournalTemplate getJournalTemplateByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getJournalTemplateByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the journal templates.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of journal templates to return
196            * @param end the upper bound of the range of journal templates to return (not inclusive)
197            * @return the range of journal templates
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getJournalTemplates(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getJournalTemplates(start, end);
204            }
205    
206            /**
207            * Gets the number of journal templates.
208            *
209            * @return the number of journal templates
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getJournalTemplatesCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getJournalTemplatesCount();
215            }
216    
217            /**
218            * Updates the journal template in the database. Also notifies the appropriate model listeners.
219            *
220            * @param journalTemplate the journal template to update
221            * @return the journal template that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
225                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateJournalTemplate(journalTemplate);
228            }
229    
230            /**
231            * Updates the journal template in the database. Also notifies the appropriate model listeners.
232            *
233            * @param journalTemplate the journal template to update
234            * @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.
235            * @return the journal template that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
239                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateJournalTemplate(journalTemplate, merge);
243            }
244    
245            public static com.liferay.portlet.journal.model.JournalTemplate addTemplate(
246                    long userId, long groupId, java.lang.String templateId,
247                    boolean autoTemplateId, java.lang.String structureId,
248                    java.lang.String name, java.lang.String description,
249                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
250                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
251                    java.io.File smallFile,
252                    com.liferay.portal.service.ServiceContext serviceContext)
253                    throws com.liferay.portal.kernel.exception.PortalException,
254                            com.liferay.portal.kernel.exception.SystemException {
255                    return getService()
256                                       .addTemplate(userId, groupId, templateId, autoTemplateId,
257                            structureId, name, description, xsl, formatXsl, langType,
258                            cacheable, smallImage, smallImageURL, smallFile, serviceContext);
259            }
260    
261            public static void addTemplateResources(long groupId,
262                    java.lang.String templateId, boolean addCommunityPermissions,
263                    boolean addGuestPermissions)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException {
266                    getService()
267                            .addTemplateResources(groupId, templateId, addCommunityPermissions,
268                            addGuestPermissions);
269            }
270    
271            public static void addTemplateResources(
272                    com.liferay.portlet.journal.model.JournalTemplate template,
273                    boolean addCommunityPermissions, boolean addGuestPermissions)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    getService()
277                            .addTemplateResources(template, addCommunityPermissions,
278                            addGuestPermissions);
279            }
280    
281            public static void addTemplateResources(long groupId,
282                    java.lang.String templateId, java.lang.String[] communityPermissions,
283                    java.lang.String[] guestPermissions)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    getService()
287                            .addTemplateResources(groupId, templateId, communityPermissions,
288                            guestPermissions);
289            }
290    
291            public static void addTemplateResources(
292                    com.liferay.portlet.journal.model.JournalTemplate template,
293                    java.lang.String[] communityPermissions,
294                    java.lang.String[] guestPermissions)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService()
298                            .addTemplateResources(template, communityPermissions,
299                            guestPermissions);
300            }
301    
302            public static void checkNewLine(long groupId, java.lang.String templateId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService().checkNewLine(groupId, templateId);
306            }
307    
308            public static com.liferay.portlet.journal.model.JournalTemplate copyTemplate(
309                    long userId, long groupId, java.lang.String oldTemplateId,
310                    java.lang.String newTemplateId, boolean autoTemplateId)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException {
313                    return getService()
314                                       .copyTemplate(userId, groupId, oldTemplateId, newTemplateId,
315                            autoTemplateId);
316            }
317    
318            public static void deleteTemplate(long groupId, java.lang.String templateId)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    getService().deleteTemplate(groupId, templateId);
322            }
323    
324            public static void deleteTemplate(
325                    com.liferay.portlet.journal.model.JournalTemplate template)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    getService().deleteTemplate(template);
329            }
330    
331            public static void deleteTemplates(long groupId)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    getService().deleteTemplates(groupId);
335            }
336    
337            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
338                    long groupId, java.lang.String structureId)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getStructureTemplates(groupId, structureId);
341            }
342    
343            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
344                    long groupId, java.lang.String structureId, int start, int end)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService()
347                                       .getStructureTemplates(groupId, structureId, start, end);
348            }
349    
350            public static int getStructureTemplatesCount(long groupId,
351                    java.lang.String structureId)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getStructureTemplatesCount(groupId, structureId);
354            }
355    
356            public static com.liferay.portlet.journal.model.JournalTemplate getTemplate(
357                    long id)
358                    throws com.liferay.portal.kernel.exception.PortalException,
359                            com.liferay.portal.kernel.exception.SystemException {
360                    return getService().getTemplate(id);
361            }
362    
363            public static com.liferay.portlet.journal.model.JournalTemplate getTemplate(
364                    long groupId, java.lang.String templateId)
365                    throws com.liferay.portal.kernel.exception.PortalException,
366                            com.liferay.portal.kernel.exception.SystemException {
367                    return getService().getTemplate(groupId, templateId);
368            }
369    
370            public static com.liferay.portlet.journal.model.JournalTemplate getTemplateBySmallImageId(
371                    long smallImageId)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getTemplateBySmallImageId(smallImageId);
375            }
376    
377            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates()
378                    throws com.liferay.portal.kernel.exception.SystemException {
379                    return getService().getTemplates();
380            }
381    
382            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
383                    long groupId)
384                    throws com.liferay.portal.kernel.exception.SystemException {
385                    return getService().getTemplates(groupId);
386            }
387    
388            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
389                    long groupId, int start, int end)
390                    throws com.liferay.portal.kernel.exception.SystemException {
391                    return getService().getTemplates(groupId, start, end);
392            }
393    
394            public static int getTemplatesCount(long groupId)
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getTemplatesCount(groupId);
397            }
398    
399            public static boolean hasTemplate(long groupId, java.lang.String templateId)
400                    throws com.liferay.portal.kernel.exception.SystemException {
401                    return getService().hasTemplate(groupId, templateId);
402            }
403    
404            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
405                    long companyId, long groupId, java.lang.String keywords,
406                    java.lang.String structureId, java.lang.String structureIdComparator,
407                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return getService()
410                                       .search(companyId, groupId, keywords, structureId,
411                            structureIdComparator, start, end, obc);
412            }
413    
414            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
415                    long companyId, long groupId, java.lang.String templateId,
416                    java.lang.String structureId, java.lang.String structureIdComparator,
417                    java.lang.String name, java.lang.String description,
418                    boolean andOperator, int start, int end,
419                    com.liferay.portal.kernel.util.OrderByComparator obc)
420                    throws com.liferay.portal.kernel.exception.SystemException {
421                    return getService()
422                                       .search(companyId, groupId, templateId, structureId,
423                            structureIdComparator, name, description, andOperator, start, end,
424                            obc);
425            }
426    
427            public static int searchCount(long companyId, long groupId,
428                    java.lang.String keywords, java.lang.String structureId,
429                    java.lang.String structureIdComparator)
430                    throws com.liferay.portal.kernel.exception.SystemException {
431                    return getService()
432                                       .searchCount(companyId, groupId, keywords, structureId,
433                            structureIdComparator);
434            }
435    
436            public static int searchCount(long companyId, long groupId,
437                    java.lang.String templateId, java.lang.String structureId,
438                    java.lang.String structureIdComparator, java.lang.String name,
439                    java.lang.String description, boolean andOperator)
440                    throws com.liferay.portal.kernel.exception.SystemException {
441                    return getService()
442                                       .searchCount(companyId, groupId, templateId, structureId,
443                            structureIdComparator, name, description, andOperator);
444            }
445    
446            public static com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
447                    long groupId, java.lang.String templateId,
448                    java.lang.String structureId, java.lang.String name,
449                    java.lang.String description, java.lang.String xsl, boolean formatXsl,
450                    java.lang.String langType, boolean cacheable, boolean smallImage,
451                    java.lang.String smallImageURL, java.io.File smallFile,
452                    com.liferay.portal.service.ServiceContext serviceContext)
453                    throws com.liferay.portal.kernel.exception.PortalException,
454                            com.liferay.portal.kernel.exception.SystemException {
455                    return getService()
456                                       .updateTemplate(groupId, templateId, structureId, name,
457                            description, xsl, formatXsl, langType, cacheable, smallImage,
458                            smallImageURL, smallFile, serviceContext);
459            }
460    
461            public static JournalTemplateLocalService getService() {
462                    if (_service == null) {
463                            _service = (JournalTemplateLocalService)PortalBeanLocatorUtil.locate(JournalTemplateLocalService.class.getName());
464                    }
465    
466                    return _service;
467            }
468    
469            public void setService(JournalTemplateLocalService service) {
470                    _service = service;
471            }
472    
473            private static JournalTemplateLocalService _service;
474    }