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.jsonwebservice.JSONWebService;
020    import com.liferay.portal.kernel.transaction.Isolation;
021    import com.liferay.portal.kernel.transaction.Propagation;
022    import com.liferay.portal.kernel.transaction.Transactional;
023    import com.liferay.portal.security.ac.AccessControlled;
024    import com.liferay.portal.service.BaseService;
025    
026    /**
027     * Provides the remote service interface for JournalTemplate. Methods of this
028     * service are expected to have security checks based on the propagated JAAS
029     * credentials because this service can be accessed remotely.
030     *
031     * @author Brian Wing Shun Chan
032     * @see JournalTemplateServiceUtil
033     * @see com.liferay.portlet.journal.service.base.JournalTemplateServiceBaseImpl
034     * @see com.liferay.portlet.journal.service.impl.JournalTemplateServiceImpl
035     * @deprecated As of 6.2.0, since Web Content Administration now uses the
036                Dynamic Data Mapping framework to handle templates
037     * @generated
038     */
039    @AccessControlled
040    @JSONWebService
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface JournalTemplateService extends BaseService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * Never modify or reference this interface directly. Always use {@link JournalTemplateServiceUtil} to access the journal template remote service. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalTemplateServiceImpl} 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 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    
076            public com.liferay.portlet.journal.model.JournalTemplate addTemplate(
077                    long groupId, java.lang.String templateId, boolean autoTemplateId,
078                    java.lang.String structureId,
079                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
080                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
081                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
082                    boolean cacheable,
083                    com.liferay.portal.service.ServiceContext serviceContext)
084                    throws com.liferay.portal.kernel.exception.PortalException,
085                            com.liferay.portal.kernel.exception.SystemException;
086    
087            public com.liferay.portlet.journal.model.JournalTemplate copyTemplate(
088                    long groupId, java.lang.String oldTemplateId,
089                    java.lang.String newTemplateId, boolean autoTemplateId)
090                    throws com.liferay.portal.kernel.exception.PortalException,
091                            com.liferay.portal.kernel.exception.SystemException;
092    
093            public void deleteTemplate(long groupId, java.lang.String templateId)
094                    throws com.liferay.portal.kernel.exception.PortalException,
095                            com.liferay.portal.kernel.exception.SystemException;
096    
097            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
098            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
099                    long groupId, java.lang.String structureId)
100                    throws com.liferay.portal.kernel.exception.PortalException,
101                            com.liferay.portal.kernel.exception.SystemException;
102    
103            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
104            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
105                    long groupId, java.lang.String templateId)
106                    throws com.liferay.portal.kernel.exception.PortalException,
107                            com.liferay.portal.kernel.exception.SystemException;
108    
109            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
110            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
111                    long groupId, java.lang.String templateId,
112                    boolean includeGlobalTemplates)
113                    throws com.liferay.portal.kernel.exception.PortalException,
114                            com.liferay.portal.kernel.exception.SystemException;
115    
116            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
117            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
118                    long companyId, long[] groupIds, java.lang.String keywords,
119                    java.lang.String structureId, java.lang.String structureIdComparator,
120                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
121                    throws com.liferay.portal.kernel.exception.SystemException;
122    
123            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
124            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
125                    long companyId, long[] groupIds, java.lang.String templateId,
126                    java.lang.String structureId, java.lang.String structureIdComparator,
127                    java.lang.String name, java.lang.String description,
128                    boolean andOperator, int start, int end,
129                    com.liferay.portal.kernel.util.OrderByComparator obc)
130                    throws com.liferay.portal.kernel.exception.SystemException;
131    
132            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133            public int searchCount(long companyId, long[] groupIds,
134                    java.lang.String keywords, java.lang.String structureId,
135                    java.lang.String structureIdComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
139            public int searchCount(long companyId, long[] groupIds,
140                    java.lang.String templateId, java.lang.String structureId,
141                    java.lang.String structureIdComparator, java.lang.String name,
142                    java.lang.String description, boolean andOperator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            public com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
146                    long groupId, java.lang.String templateId,
147                    java.lang.String structureId,
148                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
149                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
150                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
151                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
152                    java.io.File smallFile,
153                    com.liferay.portal.service.ServiceContext serviceContext)
154                    throws com.liferay.portal.kernel.exception.PortalException,
155                            com.liferay.portal.kernel.exception.SystemException;
156    
157            public com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
158                    long groupId, java.lang.String templateId,
159                    java.lang.String structureId,
160                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
161                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
162                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
163                    boolean cacheable,
164                    com.liferay.portal.service.ServiceContext serviceContext)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    }