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