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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the remote service utility for JournalTemplate. This utility wraps
024     * {@link com.liferay.portlet.journal.service.impl.JournalTemplateServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on a remote server. Methods of this service are expected to have security
027     * checks based on the propagated JAAS credentials because this service can be
028     * accessed remotely.
029     *
030     * @author Brian Wing Shun Chan
031     * @see JournalTemplateService
032     * @see com.liferay.portlet.journal.service.base.JournalTemplateServiceBaseImpl
033     * @see com.liferay.portlet.journal.service.impl.JournalTemplateServiceImpl
034     * @deprecated As of 6.2.0, since Web Content Administration now uses the
035    Dynamic Data Mapping framework to handle templates
036     * @generated
037     */
038    @ProviderType
039    public class JournalTemplateServiceUtil {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalTemplateServiceImpl} and rerun ServiceBuilder to regenerate this class.
044             */
045    
046            /**
047            * Returns the Spring bean ID for this bean.
048            *
049            * @return the Spring bean ID for this bean
050            */
051            public static java.lang.String getBeanIdentifier() {
052                    return getService().getBeanIdentifier();
053            }
054    
055            /**
056            * Sets the Spring bean ID for this bean.
057            *
058            * @param beanIdentifier the Spring bean ID for this bean
059            */
060            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
061                    getService().setBeanIdentifier(beanIdentifier);
062            }
063    
064            public static com.liferay.portlet.journal.model.JournalTemplate addTemplate(
065                    long groupId, java.lang.String templateId, boolean autoTemplateId,
066                    java.lang.String structureId,
067                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
068                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
069                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
070                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
071                    java.io.File smallFile,
072                    com.liferay.portal.service.ServiceContext serviceContext)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    return getService()
076                                       .addTemplate(groupId, templateId, autoTemplateId,
077                            structureId, nameMap, descriptionMap, xsl, formatXsl, langType,
078                            cacheable, smallImage, smallImageURL, smallFile, serviceContext);
079            }
080    
081            public static com.liferay.portlet.journal.model.JournalTemplate addTemplate(
082                    long groupId, java.lang.String templateId, boolean autoTemplateId,
083                    java.lang.String structureId,
084                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
085                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
086                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
087                    boolean cacheable,
088                    com.liferay.portal.service.ServiceContext serviceContext)
089                    throws com.liferay.portal.kernel.exception.PortalException,
090                            com.liferay.portal.kernel.exception.SystemException {
091                    return getService()
092                                       .addTemplate(groupId, templateId, autoTemplateId,
093                            structureId, nameMap, descriptionMap, xsl, formatXsl, langType,
094                            cacheable, serviceContext);
095            }
096    
097            public static com.liferay.portlet.journal.model.JournalTemplate copyTemplate(
098                    long groupId, java.lang.String oldTemplateId,
099                    java.lang.String newTemplateId, boolean autoTemplateId)
100                    throws com.liferay.portal.kernel.exception.PortalException,
101                            com.liferay.portal.kernel.exception.SystemException {
102                    return getService()
103                                       .copyTemplate(groupId, oldTemplateId, newTemplateId,
104                            autoTemplateId);
105            }
106    
107            public static void deleteTemplate(long groupId, java.lang.String templateId)
108                    throws com.liferay.portal.kernel.exception.PortalException,
109                            com.liferay.portal.kernel.exception.SystemException {
110                    getService().deleteTemplate(groupId, templateId);
111            }
112    
113            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
114                    long groupId, java.lang.String structureId)
115                    throws com.liferay.portal.kernel.exception.PortalException,
116                            com.liferay.portal.kernel.exception.SystemException {
117                    return getService().getStructureTemplates(groupId, structureId);
118            }
119    
120            public static com.liferay.portlet.journal.model.JournalTemplate getTemplate(
121                    long groupId, java.lang.String templateId)
122                    throws com.liferay.portal.kernel.exception.PortalException,
123                            com.liferay.portal.kernel.exception.SystemException {
124                    return getService().getTemplate(groupId, templateId);
125            }
126    
127            public static com.liferay.portlet.journal.model.JournalTemplate getTemplate(
128                    long groupId, java.lang.String templateId,
129                    boolean includeGlobalTemplates)
130                    throws com.liferay.portal.kernel.exception.PortalException,
131                            com.liferay.portal.kernel.exception.SystemException {
132                    return getService()
133                                       .getTemplate(groupId, templateId, includeGlobalTemplates);
134            }
135    
136            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
137                    long companyId, long[] groupIds, java.lang.String keywords,
138                    java.lang.String structureId, java.lang.String structureIdComparator,
139                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
140                    throws com.liferay.portal.kernel.exception.SystemException {
141                    return getService()
142                                       .search(companyId, groupIds, keywords, structureId,
143                            structureIdComparator, start, end, obc);
144            }
145    
146            public static java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
147                    long companyId, long[] groupIds, java.lang.String templateId,
148                    java.lang.String structureId, java.lang.String structureIdComparator,
149                    java.lang.String name, java.lang.String description,
150                    boolean andOperator, int start, int end,
151                    com.liferay.portal.kernel.util.OrderByComparator obc)
152                    throws com.liferay.portal.kernel.exception.SystemException {
153                    return getService()
154                                       .search(companyId, groupIds, templateId, structureId,
155                            structureIdComparator, name, description, andOperator, start, end,
156                            obc);
157            }
158    
159            public static int searchCount(long companyId, long[] groupIds,
160                    java.lang.String keywords, java.lang.String structureId,
161                    java.lang.String structureIdComparator)
162                    throws com.liferay.portal.kernel.exception.SystemException {
163                    return getService()
164                                       .searchCount(companyId, groupIds, keywords, structureId,
165                            structureIdComparator);
166            }
167    
168            public static int searchCount(long companyId, long[] groupIds,
169                    java.lang.String templateId, java.lang.String structureId,
170                    java.lang.String structureIdComparator, java.lang.String name,
171                    java.lang.String description, boolean andOperator)
172                    throws com.liferay.portal.kernel.exception.SystemException {
173                    return getService()
174                                       .searchCount(companyId, groupIds, templateId, structureId,
175                            structureIdComparator, name, description, andOperator);
176            }
177    
178            public static com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
179                    long groupId, java.lang.String templateId,
180                    java.lang.String structureId,
181                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
182                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
183                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
184                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
185                    java.io.File smallFile,
186                    com.liferay.portal.service.ServiceContext serviceContext)
187                    throws com.liferay.portal.kernel.exception.PortalException,
188                            com.liferay.portal.kernel.exception.SystemException {
189                    return getService()
190                                       .updateTemplate(groupId, templateId, structureId, nameMap,
191                            descriptionMap, xsl, formatXsl, langType, cacheable, smallImage,
192                            smallImageURL, smallFile, serviceContext);
193            }
194    
195            public static com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
196                    long groupId, java.lang.String templateId,
197                    java.lang.String structureId,
198                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
199                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
200                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
201                    boolean cacheable,
202                    com.liferay.portal.service.ServiceContext serviceContext)
203                    throws com.liferay.portal.kernel.exception.PortalException,
204                            com.liferay.portal.kernel.exception.SystemException {
205                    return getService()
206                                       .updateTemplate(groupId, templateId, structureId, nameMap,
207                            descriptionMap, xsl, formatXsl, langType, cacheable, serviceContext);
208            }
209    
210            public static JournalTemplateService getService() {
211                    if (_service == null) {
212                            _service = (JournalTemplateService)PortalBeanLocatorUtil.locate(JournalTemplateService.class.getName());
213    
214                            ReferenceRegistry.registerReference(JournalTemplateServiceUtil.class,
215                                    "_service");
216                    }
217    
218                    return _service;
219            }
220    
221            /**
222             * @deprecated As of 6.2.0
223             */
224            public void setService(JournalTemplateService service) {
225            }
226    
227            private static JournalTemplateService _service;
228    }