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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.BaseLocalService;
023    
024    /**
025     * Provides the local service interface for JournalTemplate. Methods of this
026     * service will not have security checks based on the propagated JAAS
027     * credentials because this service can only be accessed from within the same
028     * VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see JournalTemplateLocalServiceUtil
032     * @see com.liferay.portlet.journal.service.base.JournalTemplateLocalServiceBaseImpl
033     * @see com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl
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    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface JournalTemplateLocalService extends BaseLocalService {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. Always use {@link JournalTemplateLocalServiceUtil} to access the journal template local service. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
045             */
046    
047            /**
048            * Returns the Spring bean ID for this bean.
049            *
050            * @return the Spring bean ID for this bean
051            */
052            public java.lang.String getBeanIdentifier();
053    
054            /**
055            * Sets the Spring bean ID for this bean.
056            *
057            * @param beanIdentifier the Spring bean ID for this bean
058            */
059            public void setBeanIdentifier(java.lang.String beanIdentifier);
060    
061            public com.liferay.portlet.journal.model.JournalTemplate addJournalTemplate(
062                    com.liferay.portlet.journal.model.JournalTemplate template)
063                    throws com.liferay.portal.kernel.exception.PortalException,
064                            com.liferay.portal.kernel.exception.SystemException;
065    
066            public com.liferay.portlet.journal.model.JournalTemplate addTemplate(
067                    long userId, long groupId, java.lang.String templateId,
068                    boolean autoTemplateId, java.lang.String structureId,
069                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
070                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
071                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
072                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
073                    java.io.File smallImageFile,
074                    com.liferay.portal.service.ServiceContext serviceContext)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException;
077    
078            public void addTemplateResources(
079                    com.liferay.portlet.journal.model.JournalTemplate template,
080                    boolean addGroupPermissions, boolean addGuestPermissions)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            public void addTemplateResources(
085                    com.liferay.portlet.journal.model.JournalTemplate template,
086                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException;
089    
090            public void addTemplateResources(long groupId, java.lang.String templateId,
091                    boolean addGroupPermissions, boolean addGuestPermissions)
092                    throws com.liferay.portal.kernel.exception.PortalException,
093                            com.liferay.portal.kernel.exception.SystemException;
094    
095            public void addTemplateResources(long groupId, java.lang.String templateId,
096                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
097                    throws com.liferay.portal.kernel.exception.PortalException,
098                            com.liferay.portal.kernel.exception.SystemException;
099    
100            public void checkNewLine(long groupId, java.lang.String templateId)
101                    throws com.liferay.portal.kernel.exception.PortalException,
102                            com.liferay.portal.kernel.exception.SystemException;
103    
104            public com.liferay.portlet.journal.model.JournalTemplate copyTemplate(
105                    long userId, long groupId, java.lang.String oldTemplateId,
106                    java.lang.String newTemplateId, boolean autoTemplateId)
107                    throws com.liferay.portal.kernel.exception.PortalException,
108                            com.liferay.portal.kernel.exception.SystemException;
109    
110            public com.liferay.portlet.journal.model.JournalTemplate createJournalTemplate(
111                    long id);
112    
113            public void deleteTemplate(
114                    com.liferay.portlet.journal.model.JournalTemplate template)
115                    throws com.liferay.portal.kernel.exception.PortalException,
116                            com.liferay.portal.kernel.exception.SystemException;
117    
118            public void deleteTemplate(long groupId, java.lang.String templateId)
119                    throws com.liferay.portal.kernel.exception.PortalException,
120                            com.liferay.portal.kernel.exception.SystemException;
121    
122            public void deleteTemplates(long groupId)
123                    throws com.liferay.portal.kernel.exception.PortalException,
124                            com.liferay.portal.kernel.exception.SystemException;
125    
126            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
127            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
128                    long groupId, java.lang.String structureId)
129                    throws com.liferay.portal.kernel.exception.PortalException,
130                            com.liferay.portal.kernel.exception.SystemException;
131    
132            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
134                    long groupId, java.lang.String structureId,
135                    boolean includeGlobalTemplates)
136                    throws com.liferay.portal.kernel.exception.PortalException,
137                            com.liferay.portal.kernel.exception.SystemException;
138    
139            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
140            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
141                    long groupId, java.lang.String structureId, int start, int end)
142                    throws com.liferay.portal.kernel.exception.PortalException,
143                            com.liferay.portal.kernel.exception.SystemException;
144    
145            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
146            public int getStructureTemplatesCount(long groupId,
147                    java.lang.String structureId)
148                    throws com.liferay.portal.kernel.exception.PortalException,
149                            com.liferay.portal.kernel.exception.SystemException;
150    
151            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
152            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
153                    long groupId, java.lang.String templateId)
154                    throws com.liferay.portal.kernel.exception.PortalException,
155                            com.liferay.portal.kernel.exception.SystemException;
156    
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
159                    long groupId, java.lang.String templateId,
160                    boolean includeGlobalTemplates)
161                    throws com.liferay.portal.kernel.exception.PortalException,
162                            com.liferay.portal.kernel.exception.SystemException;
163    
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public com.liferay.portlet.journal.model.JournalTemplate getTemplateBySmallImageId(
166                    long smallImageId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException;
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates()
172                    throws com.liferay.portal.kernel.exception.SystemException;
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
176                    long groupId)
177                    throws com.liferay.portal.kernel.exception.SystemException;
178    
179            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
180            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
181                    long groupId, int start, int end)
182                    throws com.liferay.portal.kernel.exception.SystemException;
183    
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public int getTemplatesCount(long groupId)
186                    throws com.liferay.portal.kernel.exception.SystemException;
187    
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public boolean hasTemplate(long groupId, java.lang.String templateId)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
194                    long companyId, long[] groupIds, java.lang.String keywords,
195                    java.lang.String structureId, java.lang.String structureIdComparator,
196                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
197                    throws com.liferay.portal.kernel.exception.SystemException;
198    
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
201                    long companyId, long[] groupIds, java.lang.String templateId,
202                    java.lang.String structureId, java.lang.String structureIdComparator,
203                    java.lang.String name, java.lang.String description,
204                    boolean andOperator, int start, int end,
205                    com.liferay.portal.kernel.util.OrderByComparator obc)
206                    throws com.liferay.portal.kernel.exception.SystemException;
207    
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public int searchCount(long companyId, long[] groupIds,
210                    java.lang.String keywords, java.lang.String structureId,
211                    java.lang.String structureIdComparator)
212                    throws com.liferay.portal.kernel.exception.SystemException;
213    
214            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215            public int searchCount(long companyId, long[] groupIds,
216                    java.lang.String templateId, java.lang.String structureId,
217                    java.lang.String structureIdComparator, java.lang.String name,
218                    java.lang.String description, boolean andOperator)
219                    throws com.liferay.portal.kernel.exception.SystemException;
220    
221            public com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
222                    com.liferay.portlet.journal.model.JournalTemplate template)
223                    throws com.liferay.portal.kernel.exception.PortalException,
224                            com.liferay.portal.kernel.exception.SystemException;
225    
226            public com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
227                    long groupId, java.lang.String templateId,
228                    java.lang.String structureId,
229                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
230                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
231                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
232                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
233                    java.io.File smallImageFile,
234                    com.liferay.portal.service.ServiceContext serviceContext)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException;
237    }