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